調べる

日本語リファレンス

同期版intelino-trainlib 1.0.0の主要API、定数、メッセージ、例外、ライセンスと報告先を日本語で探します。

今日はここまで

下の目標を確認し、無理のない区切りで終えて構いません。

  • 目的のクラスやメソッドを見つけられる
  • 公式名と日本語の役割を対応できる
  • 不具合と利用条件の公式窓口へ移動できる

始める前に

調べたい項目から読めます。Pythonコードを実行する場合は、環境準備と接続を先に終えてください。

用意するもの

  • intelino-trainlib 1.0.0
  • 公式ドキュメントを開ける環境
1

探す:TrainScanner

TrainScannerは周囲のスマートトレインを探し、接続済みのTrainオブジェクトを返します。get_trainは一台、get_trainsは複数台に使います。timeoutの初期値は5秒です。指定台数が見つからない場合はTrainNotFoundErrorになります。

from intelino.trainlib import TrainScanner

train = TrainScanner(timeout=10.0).get_train()
print(train.name, train.is_connected)
train.disconnect()
2

動かす:Train

主なプロパティはname、alias、is_connected、distance_cm、direction、speed_cmps、next_split_decisionです。主なコマンドはdrive_at_speed、drive_at_speed_level、stop_driving、set_next_split_steering_decision、set_top_led_color、set_headlight_color、set_snap_command_execution、decouple_wagonです。

3

定数:enums

ButtonPressはSHORT・LONG、ColorSensorはFRONT・BACK、MovementDirectionはCURRENT・FORWARD・BACKWARD・STOP・INVERT、SnapColorValueはBLACK・RED・GREEN・BLUE・YELLOW・MAGENTA・CYAN・WHITE・UNKNOWN、SpeedLevelはSTOP・LEVEL1〜3、SteeringDecisionはNONE・LEFT・RIGHT・STRAIGHT・STEER・ALLです。StopDrivingFeedbackTypeはNONE・MOVEMENT_STOP・END_ROUTEです。

from intelino.trainlib.enums import (
    MovementDirection,
    SnapColorValue,
    SteeringDecision,
)
4

メッセージ:messages

応答メッセージにはMACアドレス、UUID、バージョン、総走行距離、走行状態などがあります。イベントには移動方向、低電池、充電状態、ボタン、スナップコマンド、前後色センサー、分岐判断などがあります。色センサーの単色はcolor、スナップコマンドの色列はcolorsです。メッセージは基本的に読み取り専用です。

5

例外とその他のAPI

代表的な例外はTrainNotFoundErrorとTrainNotConnectedErrorです。接続再試行を無限に繰り返さず、例外名とメッセージを記録します。より低い層のBLEパケットや非同期APIは、公式リファレンスとソースを確認できる開発者向けの範囲です。

6

ライセンスと不具合報告

同期版ライブラリ本体はIntelino Public Licenseで公開されています。公式サンプルリポジトリはMIT Licenseです。不具合や要望は公式GitHub Issuesへ報告できます。端末、OS、Python、ライブラリのバージョン、再現手順、エラー全文を添え、個人情報や端末固有の秘密情報は載せません。

このページで使うもの

画像つき資料・印刷用PDF・データ

資料はサイト内で読めます。印刷や保存が必要なときだけ、詳細ページからダウンロードしてください。