from typing import Optional
from .device import Device
try:
from typing import Any, Callable, List, Tuple, Type, Union # noqa
except BaseException:
pass
def _pascal2snake(s: str) -> str:
'''パスカルケースの文字列をスネークケースに変換する。
'''
return ''.join(
'{}{}'.format(p.lower(), c.lower()) if i == 0 else
'_{}'.format(c.lower()) if not p.isupper() and c.isupper() else
c.lower()
for i, (p, c) in enumerate(zip(s[:-1], s[1:])))
[docs]
class ETRobo:
'''ロボットを制御するためのオブジェクトを作成する。
実行環境に適したバックエンドプログラムを指定すること。
以下のバックエンドプログラムを指定できる。
- simulator: Unityのシミュレータ環境でのロボット制御
- pybricks: micropythonを使ったEV3ロボットの制御
- raspike: pythonを使ったRasPikeロボットの制御（公式のmain.pyを使用する場合）
- raspyke: pythonを使ったRasPikeロボットの制御（非公式のmain.pyを使用する場合）
**プログラム例**
制御対象としてHUBタイプのデバイス「body」とmotorタイプのデバイス「motor1」を登録した場合、
制御ハンドラには Hubオブジェクトが引数「body」として、Motorオブジェクトが引数「motor1」として渡される。
シミュレータ上でHUBとモータを制御する場合は以下なプログラムとなる。
.. code-block:: python
from etrobo_python import ETRobo, Hub, Motor
def motor_handler(
body: Hub,
motor1: Motor,
) -> None:
...
etrobo = ETRobo(backend='simulator')
etrobo.add_hub('body')
etrobo.add_device('motor1', device_type=Motor, port='A')
etrobo.add_handler(motor_handler)
etrobo.dispatch()
Args:
backend: バックエンドプログラムの名前
'''
def __init__(self, backend: str) -> None:
if backend == 'simulator':
from .backends import simulator
self.backend = simulator # type: Any
elif backend == 'pybricks':
from .backends import pybricks
self.backend = pybricks
elif backend == 'raspike':
from .backends import raspike
self.backend = raspike
elif backend == 'raspyke':
from .backends import raspyke
self.backend = raspyke
elif backend == 'raspike_art':
from .backends import raspike_art
self.backend = raspike_art
else:
raise NotImplementedError(
'Unsupported backend: {}'.format(backend))
self.devices = [] # type: List[Tuple[str, Any]]
self.handlers = [] # type: List[Callable[..., None]]
[docs]
def add_hub(self, name: str) -> 'ETRobo':
'''制御対象としてHubを登録する。
このメソッドが実行された場合、Hubオブジェクトが制御ハンドラに引数として渡される。
Args:
name: 制御オブジェクトの名前（handlerに渡される引数名）。
Returns:
このオブジェクト
'''
device = self.backend.create_device('hub', '')
self.devices.append((name, device))
return self
[docs]
def add_device(
self,
name: str,
device_type: Union[str, Type[Device]],
port: str,
) -> 'ETRobo':
'''制御対象となるデバイスを登録する。
ここで登録されたデバイスオブジェクトは制御ハンドラに引数として渡される。
引数 `device_type` には以下のいずれかを指定する。
- `Motor`: モータを追加する
- `ReversedMotor`: 逆回転するモータを追加する
- `ColorSensor`: カラーセンサを追加する。
- `TouchSensor`: タッチセンサを追加する。
- `SonarSensor`: 超音波センサを追加する。
- `GyroSensor`: ジャイロセンサを追加する。
Args:
name: 制御オブジェクトの名前（handlerに渡される引数名）。
device_type: 制御デバイスの種類
port: 制御デバイスを接続しているポート
Returns:
このオブジェクト
'''
if isinstance(device_type, type):
device_type = device_type.__name__
device_type = _pascal2snake(device_type)
device = self.backend.create_device(device_type, str(port))
self.devices.append((name, device))
return self
[docs]
def add_handler(self, handler: Callable[..., None]) -> 'ETRobo':
'''制御ハンドラを登録する。
ここで登録された制御ハンドラは、制御プログラムの実行開始後に指定された間隔で実行される。
Args:
handler: 制御ハンドラ
Returns:
このオブジェクト
'''
self.handlers.append(handler)
return self
[docs]
def dispatch(
self,
interval: float = 0.01,
logfile: Optional[str] = None,
**kwargs: Any,
) -> 'ETRobo':
'''制御プログラムを実行する。
Args:
interval: 制御ハンドラの実行間隔
logfile: ログデータを保存するファイルのパス
kwargs: バックエンドプログラムに渡される引数
Returns:
このオブジェクト
'''
self.backend.create_dispatcher(
devices=self.devices,
handlers=self.handlers,
interval=interval,
logfile=logfile,
**kwargs,
).dispatch()
return self