개요
로봇을 구성하는 로보이드 또는 디바이스를 찾거나 로봇을 제어하기 위한 메소드를 정의합니다.
상속 관계:
메소드
버전 1.3.0부터
add_device_data_changed_listener(listener)
디바이스의 데이터가 갱신되었을 때 호출되도록 콜백 함수 listener를 등록한다.
listener는 on_device_data_changed(device, values)의 형태를 가지는 함수여야 한다.
함수 이름이 on_device_data_changed일 필요는 없다.
여기서 device는 데이터가 갱신된 디바이스이고, values는 해당 디바이스(device)의 데이터 리스트를 튜플로 변환한 것이다.
파라미터:
from roboid import *
hamster = Hamster()
def on_device_data_changed(device, values):
if device.get_id() == Hamster.LEFT_PROXIMITY:
left_proximity = values[0]
# 콜백 함수를 등록한다.
hamster.add_device_data_changed_listener(on_device_data_changed)
버전 1.3.0부터
clear_device_data_changed_listeners()
등록된 모든 콜백 함수를 제거한다.
버전 1.0.0부터
dispose()
로봇의 통신 연결을 종료한다.
버전 1.0.0부터
e(device_id)
ID가 device_id인 디바이스의 데이터가 갱신되었는지 확인한다.
ID가 device_id인 디바이스가 없으면 False를 반환한다.
센서 또는 이펙터 디바이스는 데이터가 계속 갱신되기 때문에 확인할 필요가 없지만,
커맨드 또는 이벤트 디바이스는 데이터를 읽기 전에 반드시 이 메소드를 사용하여 데이터가 갱신되었는지 확인해야 한다.
그렇지 않으면 커맨드 또는 이벤트가 발생한 시점을 알 수가 없기 때문에 현재 발생한 커맨드 또는 이벤트의 데이터가 아니라 과거에 발생하였던 커맨드 또는 이벤트의 데이터를 읽을 수도 있다.
파라미터:
반환 값:
디바이스의 데이터가 갱신되었으면 True, 아니면 False
from roboid import *
hamster = Hamster()
if hamster.e(Hamster.LINE_TRACER_STATE): # 데이터가 갱신되었는지 확인한다.
state = hamster.read(Hamster.LINE_TRACER_STATE) # 데이터를 읽는다.
버전 1.3.0부터
find_device_by_id(device_id)
ID가 device_id인 디바이스를 찾는다.
ID가 device_id인 디바이스가 없으면 None을 반환한다.
파라미터:
- device_id: 찾을 디바이스의 ID(정수)
반환 값:
디바이스(Device) 인스턴스의 참조 또는 None
from roboid import *
hamster = Hamster()
# 왼쪽 바퀴 디바이스를 찾는다.
device = hamster.find_device_by_id(Hamster.LEFT_WHEEL)
버전 1.3.0부터
find_device_by_name(name)
이름이 name인 디바이스를 찾는다.
이름이 name인 디바이스가 없으면 None을 반환한다.
이 때, 자식 로보이드에 포함된 디바이스의 이름은 '자식로보이드.디바이스'와 같이 '.'으로 구분된 형식을 사용한다. 예: 'Hamster.LeftWheel'
파라미터:
반환 값:
디바이스(Device) 인스턴스의 참조 또는 None
from roboid import *
hamster = Hamster()
# 왼쪽 바퀴 디바이스를 찾는다.
device = hamster.find_device_by_name('Hamster.LeftWheel')
버전 1.3.0부터
find_roboid_by_name(name)
이름이 name인 로보이드를 찾는다.
이름이 name인 로보이드가 없으면 None을 반환한다.
이 때, 자식 로보이드에 포함된 로보이드의 이름은 '자식로보이드.로보이드'와 같이 '.'으로 구분된 형식을 사용한다. 예: 'Child.Pen'
파라미터:
반환 값:
로보이드(Device) 인스턴스의 참조 또는 None
from roboid import *
hamster = Hamster()
roboid = hamster.find_roboid_by_name('Hamster')
버전 1.3.0부터
get_id()
로봇의 ID를 반환한다.
반환 값:
from roboid import *
hamster = Hamster()
# 로봇의 ID를 얻는다.
id = hamster.get_id()
버전 1.3.0부터
get_index()
몇 번째 로봇인지를 나타내는 인덱스를 반환한다.
로봇의 인스턴스를 생성할 때 순서대로 0부터 시작하여 부여되는 일련 번호이다.
인덱스는 로봇들을 모델 기준으로 그룹핑하여 각 그룹 별로 순서대로 일련 번호가 부여된다.
즉, 로봇의 모델이 다르면 인덱스는 0부터 새로 시작한다.
따라서 로봇의 모델 ID와 인덱스를 사용하여 각각의 로봇을 구분할 수 있다.
예를 들어 햄스터 로봇 3대와 거북이 로봇 2대를 사용 중이라면,
햄스터 로봇 3대가 순서대로 0, 1, 2의 일련 번호(인덱스)를 가지고,
거북이 로봇 2대가 0, 1의 일련 번호(인덱스)를 가진다.
반환 값:
from roboid import *
hamster = Hamster()
# 첫 번째 햄스터 로봇임을 확인한다.
if hamster.get_index() == 0:
...
버전 1.3.0부터
get_name()
로봇의 이름을 반환한다.
반환 값:
from roboid import *
hamster = Hamster()
# 로봇의 이름을 얻는다.
name = hamster.get_name()
버전 1.0.0부터
read(device_id)
ID가 device_id인 디바이스의 데이터 리스트에서 인덱스 0의 위치에 있는 데이터를 반환한다.
ID가 device_id인 디바이스가 없으면 0을 반환한다.
디바이스의 데이터 리스트 크기가 0인 경우에는 디바이스의 데이터 형에 따라 0 또는 빈 문자열('')을 반환한다.
파라미터:
반환 값:
디바이스의 데이터 값(정수/실수/문자열) 또는 0 또는 빈 문자열('')
from roboid import *
hamster = Hamster()
# 왼쪽 근접 센서 값을 얻는다.
value = hamster.read(Hamster.LEFT_PROXIMITY)
버전 1.0.0부터
read(device_id, index)
ID가 device_id인 디바이스의 데이터 리스트에서 인덱스가 index인 위치에 있는 데이터를 반환한다.
ID가 device_id인 디바이스가 없으면 0을 반환한다.
index가 디바이스의 데이터 리스트 크기보다 크거나 같은 경우, 혹은 index가 음수인 경우에는 디바이스의 데이터 형에 따라 0 또는 빈 문자열('')을 반환한다.
파라미터:
- device_id: 디바이스 ID(정수)
- index: 디바이스 데이터 리스트의 인덱스(정수)
반환 값:
디바이스의 데이터 값(정수/실수/문자열) 또는 0 또는 빈 문자열('')
from roboid import *
hamster = Hamster()
# Y축 가속도 값을 얻는다.
value = hamster.read(Hamster.ACCELERATION, 1)
버전 1.0.0부터
read(device_id, list)
ID가 device_id인 디바이스의 데이터 리스트를 list 리스트에 복사하고, 복사한 데이터의 개수를 반환한다.
ID가 device_id인 디바이스가 없으면 0을 반환한다.
list 리스트의 크기가 디바이스의 데이터 리스트 크기보다 작은 경우에는 list 리스트의 크기만큼만 복사한다.
디바이스의 데이터 리스트 크기가 list 리스트의 크기보다 작은 경우에는 디바이스의 데이터 리스트 크기만큼만 복사한다.
list 리스트의 크기가 0인 경우에는 복사하지 않고 0을 반환한다.
파라미터:
- device_id: 디바이스 ID(정수)
- list: 디바이스의 데이터 리스트를 복사할 리스트
반환 값:
from roboid import *
hamster = Hamster()
data = [0] * 3
# 3축 가속도 센서 값을 모두 얻는다.
hamster.read(Hamster.ACCELERATION, data)
버전 1.3.0부터
remove_device_data_changed_listener(listener)
등록된 콜백 함수 목록에서 listener를 제거한다.
listener는 on_device_data_changed(device, values)의 형태를 가지는 함수여야 한다.
함수 이름이 on_device_data_changed일 필요는 없다.
여기서 device는 데이터가 갱신된 디바이스이고, values는 해당 디바이스(device)의 데이터 리스트를 튜플로 변환한 것이다.
파라미터:
from roboid import *
hamster = Hamster()
def on_device_data_changed(device, values):
if device.get_id() == Hamster.LEFT_PROXIMITY:
left_proximity = values[0]
# 콜백 함수를 제거한다.
hamster.remove_device_data_changed_listener(on_device_data_changed)
버전 1.0.0부터
reset()
모든 디바이스의 데이터를 초기화한다.
버전 1.3.0부터
set_name(name)
로봇의 이름을 name으로 설정한다.
파라미터:
from roboid import *
hamster = Hamster()
# 로봇의 이름을 'Hamster'로 설정한다.
hamster.set_name('Hamster')
버전 1.0.0부터
write(device_id, data)
ID가 device_id인 디바이스의 데이터 리스트에서 인덱스 0의 위치에 data를 쓴다.
ID가 device_id인 디바이스가 없으면 False를 반환한다.
디바이스의 데이터 리스트 크기가 0인 경우에는 쓰지 않고 False를 반환한다.
파라미터:
- device_id: 디바이스 ID(정수)
- data: 디바이스에 쓸 데이터(정수/실수/문자열)
반환 값:
from roboid import *
hamster = Hamster()
# 왼쪽 바퀴의 속도를 30으로 한다.
hamster.write(Hamster.LEFT_WHEEL, 30)
버전 1.0.0부터
write(device_id, index, data)
ID가 device_id인 디바이스의 데이터 리스트에서 인덱스가 index인 위치에 data를 쓴다.
ID가 device_id인 디바이스가 없으면 False를 반환한다.
index가 디바이스의 데이터 리스트 크기보다 크거나 같은 경우, 혹은 index가 음수인 경우에는 쓰지 않고 False를 반환한다.
파라미터:
- device_id: 디바이스 ID(정수)
- index: 디바이스 데이터 리스트의 인덱스(정수)
- data: 디바이스에 쓸 데이터(정수/실수/문자열)
반환 값:
from roboid import *
hamster = Hamster()
# 왼쪽 바퀴의 속도를 30으로 한다.
hamster.write(Hamster.LEFT_WHEEL, 0, 30)
버전 1.0.0부터
write(device_id, list)
ID가 device_id인 디바이스의 데이터 리스트에 list 리스트(또는 튜플)를 복사하고, 복사한 데이터의 개수를 반환한다.
ID가 device_id인 디바이스가 없으면 0을 반환한다.
list 리스트(또는 튜플)의 크기가 디바이스의 데이터 리스트 크기보다 작은 경우에는 list 리스트(또는 튜플)의 크기만큼만 복사한다.
디바이스의 데이터 리스트 크기가 list 리스트(또는 튜플)의 크기보다 작은 경우에는 디바이스의 데이터 리스트 크기만큼만 복사한다.
list가 리스트 또는 튜플이 아닌 경우에는 복사하지 않고 0을 반환한다.
list 리스트(또는 튜플)의 크기가 0인 경우에는 복사하지 않고 0을 반환한다.
디바이스의 데이터 리스트 크기가 가변적인 경우(데이터 리스트 크기가 -1로 지정된 경우)에는 list 리스트(또는 튜플)의 크기만큼 디바이스의 데이터 리스트를 새로 만들어서 list 리스트(또는 튜플)를 복사한다.
파라미터:
- device_id: 디바이스 ID(정수)
- list: 디바이스의 데이터 리스트에 복사할 리스트 또는 튜플
반환 값:
Copyright 로봇SW교육원 All rights reserved.
어려운 일이 있으면 광운대학교 로봇학부 박광현 교수(
akaii@kw.ac.kr)에게 연락하세요.
