ZumiAI API 개요
==================
이 문서는 ZumiAI 라이브러리의 모든 주요 메서드를 요약하여 보여줍니다.
ZumiAI와 상호작용하는 데 필요한 핵심 기능들을 한눈에 파악할 수 있도록 분류되어 있습니다.
------------------------------------------------------
.. raw:: html
주미 AI 설치 방법
주미 AI를 사용하기 위한 설치는 두 가지 방식으로 나뉩니다. 사용 목적에 맞게 선택하여 설치해 주세요.
1. 🔌 기본 설치 (동글 버전)
이 방법은 주미와 함께 제공되는 USB 동글을 사용하는 가장 기본적인 설치 방식입니다.
- 권장 파이썬 버전: 3.9 이상
- 장점: 설치와 연결이 매우 빠르고 간편합니다. 코딩에 집중하고 싶을 때 적합합니다.
- 단점: 카메라 스트리밍을 통한 고급 기능은 사용할 수 없습니다.
pip install zumi-ai
2. 🌐 고급 설치 (스트리밍 및 비전 기능 지원)
이 방법은 주미와 IP 주소를 직접 입력하여 연결하며, 카메라 스트리밍을 통한 AI 비전 기능을 사용할 수 있는 고급 설치 방식입니다.
- 권장 파이썬 버전: 3.12.3 이상의 3.12.x 모든 버전 (3.13은 현재 지원되지 않습니다)
- 장점: 주미의 카메라 영상을 실시간 스트리밍하여 강력한 AI 기능을 활용할 수 있습니다.
- 단점: 설치해야 할 추가 라이브러리가 많아 설치 시간이 오래 걸릴 수 있습니다.
pip install zumi-ai[pro]
🌐 카메라 스트리밍 버전을 위한 준비물
- 무선 공유기 (2.4GHz 필수): Zumi와 PC가 같은 네트워크에 연결되도록 하는 필수 장비입니다.
- 안정적인 Wi-Fi 연결: Zumi와 PC 모두 공유기에 안정적으로 연결되어야 스트리밍이 끊기지 않습니다.
⚠️ **참고:** 주변에 무선 장비가 많거나 신호가 복잡한 환경에서는 간섭으로 인해 연결이 불안정해지거나 스트리밍 품질이 떨어질 수 있습니다.
------------------------------------------------------
.. raw:: html
※ 지원 여부 안내
함수별 지원 여부는 연결 방식에 따른 동작 가능 여부를 나타냅니다.
🔌 동글 연결 : USB 동글을 사용하여 Zumi AI에 연결한 경우
🌐 IP 연결 : 사용자가 IP 주소를 직접 입력하여 Zumi AI에 연결한 경우
일부 함수는 특정 연결 방식에서만 동작합니다. 각 함수 설명의 지원 정보를 참고하세요.
------------------------------------------------------
.. raw:: html
기본 연결 방식
Zumi AI를 사용하기 위한 기본적인 연결 방법은 아래와 같습니다.
이 코드를 통해 Zumi AI 객체를 초기화하고 연결을 설정할 수 있습니다.
from zumi_AI.zumi_AI import *
zumiAI = ZumiAI()
zumiAI.connect()
------------------------------------------------------
.. raw:: html
1) 연결 제어
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/connection
:template: function.rst
connect
disconnect
------------------------------------------------------
.. raw:: html
2) 주행 및 움직임 제어
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/movement
:template: function.rst
stop
control_motor
control_motor_time
forward_dist
reverse_dist
send_move_dist
forward_dist_quick
reverse_dist_quick
send_move_dist_quick
left_turn
right_turn
send_turn
left_turn_quick
right_turn_quick
send_turn_quick
forward_infinite
reverse_infinite
move_infinite
linefollower_distance
linefollower_infinite
linefollower
go_sensor
set_calibration_motors
------------------------------------------------------
.. raw:: html
3) 감정 및 소리
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/emotion_sound
:template: function.rst
change_emotion
play_sound
led_control
led_pattern
------------------------------------------------------
.. raw:: html
4) 화면 제어
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/camera_display
:template: function.rst
change_screen
display_text
display_text_add
display_text_clear
display_text_pos
display_text_set
#sendText
------------------------------------------------------
.. raw:: html
5) 기타 센서 및 시스템 정보
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/sensors_system_info
:template: function.rst
get_IR_sensor_all
get_IR_sensor_front
get_IR_sensor_bottom
get_battery
get_button
------------------------------------------------------
.. raw:: html
6) 키보드 인터럽트 제어
✅ 동글 연결 지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/keyboard
:template: function.rst
key_press_set
key_press_start
key_press_stop
------------------------------------------------------
.. raw:: html
7) 기본 카메라 인식 기능
✅ 동글 연결 지원 |
❌ IP 연결 미지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/basic_camera
:template: function.rst
set_zumi_face_detection
set_zumi_cat_detection
set_zumi_color_detection
set_zumi_marker_detection
is_zumi_face_detected
get_zumi_face_center
is_zumi_cat_detected
get_zumi_cat_center
get_zumi_color_id
get_zumi_color_center
get_zumi_marker_id
get_zumi_marker_center
------------------------------------------------------
.. raw:: html
8) 카메라 스트리밍
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/camera_streaming
:template: function.rst
camera_stream_start
camera_LR_Flip
sensor_start
sensor_visible
frame_rate_visible
------------------------------------------------------
.. raw:: html
9) 얼굴 인식
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/face_recognition
:template: function.rst
face_detector_init
face_detector_start
face_detector_stop
face_landmark_visible
face_contours_visible
is_face_detected
get_face_center
get_face_size
get_face_landmark
face_train
delete_face_data
delete_all_Face_data
get_detected_face_result
get_detected_face_name
get_detected_face_confidence_score
------------------------------------------------------
.. raw:: html
10) 마커 인식
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/marker_recognition
:template: function.rst
marker_detector_init
marker_detector_start
marker_detector_stop
is_marker_detected
get_marker_id
get_marker_center
get_marker_size
------------------------------------------------------
.. raw:: html
12) 제스처 인식
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/gesture_recognition
:template: function.rst
gesture_detector_init
gesture_detector_start
gesture_detector_stop
is_gesture_detected
get_gesture_center
get_gesture_size
get_gesture_finger
get_gesture_recognize
------------------------------------------------------
.. raw:: html
11) 스케치 인식
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/sketch_recognition
:template: function.rst
sketch_detector_init
sketch_detector_start
sketch_detector_stop
is_sketch_detected
get_sketch_center
get_sketch_size
sketch_train
delete_sketch_data
delete_all_sketch_data
get_sketch_result
get_sketch_name
get_sketch_confidence
------------------------------------------------------
.. raw:: html
13) 객체 인식(신호등, 정지 표지판)
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/traffic_sign_recognition
:template: function.rst
object_detector_init
object_detector_start
object_detector_stop
is_obj_detected
get_obj_size
get_obj_center
get_obj_confidence
get_traffic_light_color
object_check_add_obj
object_check_all_add_obj
object_check_del_obj
object_check_all_del_obj
------------------------------------------------------
.. raw:: html
14) 사용자 학습 모델 (Teachable Machine)
❌ 동글 연결 미지원 |
✅ IP 연결 지원
.. currentmodule:: zumi_AI.ZumiAI
.. autosummary::
:toctree: _autosummary_generated/teachable_machine
:template: function.rst
teachable_detector_init
teachable_detector_start
teachable_detector_stop
get_teachable_result