intelino-trainlib-async-py
v1.0.1
QUICK START
1. Library Installation
1.1. Global Installation
1.2. Local Environment Installation
1.3. Requirements and Dependencies
1.4. Local Development and Testing
2. Library Verification
3. Usage and Examples
3.1. Examples for our synchronous library
API REFERENCE GUIDE
Overview
Python API
1. TrainScanner
2. Train
3. Enums (constants)
4. Messages (from the train)
4.1. Base classes
4.2. Response messages
4.3. Event messages
4.4. Error messages
4.5. Union classes
5. Exceptions
6. Other noteworthy APIs
OTHER
Issues and Requests
Intelino Public License
intelino-trainlib-async-py
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
W
|
Y
_
__eq__() (trainlib_async.messages.SnapCommand method)
__init__() (trainlib_async.TrainScanner method)
A
alias (trainlib_async.Train property)
ALL (trainlib_async.enums.SteeringDecision attribute)
AsyncObserver (class in trainlib_async.helpers)
B
BACK (trainlib_async.enums.ColorSensor attribute)
BACKWARD (trainlib_async.enums.MovementDirection attribute)
BLACK (trainlib_async.enums.SnapColorValue attribute)
ble_api_version (trainlib_async.messages.TrainMsgVersionDetail attribute)
BLUE (trainlib_async.enums.SnapColorValue attribute)
button_press_type (trainlib_async.messages.TrainMsgEventButtonPressDetected attribute)
ButtonPress (class in trainlib_async.enums)
C
clear_custom_snap_commands() (trainlib_async.Train method)
color (trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
colors (trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
ColorSensor (class in trainlib_async.enums)
command_id (trainlib_async.messages.TrainMsgBase attribute)
(trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventBase attribute)
(trainlib_async.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib_async.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventLowBattery attribute)
(trainlib_async.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib_async.messages.TrainMsgEventSplitDecision attribute)
(trainlib_async.messages.TrainMsgEventUnknown attribute)
(trainlib_async.messages.TrainMsgMacAddress attribute)
(trainlib_async.messages.TrainMsgMalformed attribute)
(trainlib_async.messages.TrainMsgMovement attribute)
(trainlib_async.messages.TrainMsgStatsLifetimeOdometer attribute)
(trainlib_async.messages.TrainMsgTrainUuid attribute)
(trainlib_async.messages.TrainMsgUnknown attribute)
(trainlib_async.messages.TrainMsgVersionDetail attribute)
connect() (trainlib_async.Train method)
connection_status (trainlib_async.Train property)
CURRENT (trainlib_async.enums.MovementDirection attribute)
CYAN (trainlib_async.enums.SnapColorValue attribute)
D
decision (trainlib_async.messages.TrainMsgEventSplitDecision attribute)
decouple_wagon() (trainlib_async.Train method)
desired_speed_cmps (trainlib_async.messages.TrainMsgMovement attribute)
direction (trainlib_async.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib_async.messages.TrainMsgMovement attribute)
disconnect() (trainlib_async.Train method)
drive_at_speed() (trainlib_async.Train method)
drive_at_speed_level() (trainlib_async.Train method)
drive_with_constant_pwm() (trainlib_async.Train method)
E
END_ROUTE (trainlib_async.enums.StopDrivingFeedbackType attribute)
event_id (trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventBase attribute)
(trainlib_async.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib_async.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventLowBattery attribute)
(trainlib_async.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib_async.messages.TrainMsgEventSplitDecision attribute)
(trainlib_async.messages.TrainMsgEventUnknown attribute)
F
FORWARD (trainlib_async.enums.MovementDirection attribute)
FRONT (trainlib_async.enums.ColorSensor attribute)
fw_version (trainlib_async.messages.TrainMsgVersionDetail attribute)
G
get_mac_address() (trainlib_async.Train method)
get_movement_notification() (trainlib_async.Train method)
get_stats_lifetime_odometer() (trainlib_async.Train method)
get_train() (trainlib_async.TrainScanner method)
get_trains() (trainlib_async.TrainScanner method)
get_uuid() (trainlib_async.Train method)
get_version_info() (trainlib_async.Train method)
GREEN (trainlib_async.enums.SnapColorValue attribute)
I
id (trainlib_async.Train property)
INVERT (trainlib_async.enums.MovementDirection attribute)
is_charging (trainlib_async.messages.TrainMsgEventChargingStateChanged attribute)
is_connected (trainlib_async.Train property)
L
LEFT (trainlib_async.enums.SteeringDecision attribute)
LEVEL1 (trainlib_async.enums.SpeedLevel attribute)
LEVEL2 (trainlib_async.enums.SpeedLevel attribute)
LEVEL3 (trainlib_async.enums.SpeedLevel attribute)
lifetime_odometer_meters (trainlib_async.messages.TrainMsgMovement attribute)
(trainlib_async.messages.TrainMsgStatsLifetimeOdometer attribute)
LONG (trainlib_async.enums.ButtonPress attribute)
M
mac_address (trainlib_async.messages.TrainMsgMacAddress attribute)
MAGENTA (trainlib_async.enums.SnapColorValue attribute)
major (trainlib_async.messages.TrainMsgVersionDetail.Version attribute)
minor (trainlib_async.messages.TrainMsgVersionDetail.Version attribute)
module
trainlib_async
trainlib_async.enums
trainlib_async.exc
movement_notification_stream() (trainlib_async.Train method)
MOVEMENT_STOP (trainlib_async.enums.StopDrivingFeedbackType attribute)
MovementDirection (class in trainlib_async.enums)
N
name (trainlib_async.Train property)
next_split_decision (trainlib_async.messages.TrainMsgMovement attribute)
NONE (trainlib_async.enums.SteeringDecision attribute)
(trainlib_async.enums.StopDrivingFeedbackType attribute)
notifications (trainlib_async.Train property)
P
patch (trainlib_async.messages.TrainMsgVersionDetail.Version attribute)
pause_driving() (trainlib_async.Train method)
pause_time_ms (trainlib_async.messages.TrainMsgMovement attribute)
pwm (trainlib_async.messages.TrainMsgMovement attribute)
R
random() (trainlib_async.enums.SnapColorValue class method)
raw_packet (trainlib_async.messages.TrainMsgBase attribute)
(trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventBase attribute)
(trainlib_async.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib_async.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventLowBattery attribute)
(trainlib_async.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib_async.messages.TrainMsgEventSplitDecision attribute)
(trainlib_async.messages.TrainMsgEventUnknown attribute)
(trainlib_async.messages.TrainMsgMacAddress attribute)
(trainlib_async.messages.TrainMsgMalformed attribute)
(trainlib_async.messages.TrainMsgMovement attribute)
(trainlib_async.messages.TrainMsgStatsLifetimeOdometer attribute)
(trainlib_async.messages.TrainMsgTrainUuid attribute)
(trainlib_async.messages.TrainMsgUnknown attribute)
(trainlib_async.messages.TrainMsgVersionDetail attribute)
RED (trainlib_async.enums.SnapColorValue attribute)
RIGHT (trainlib_async.enums.SteeringDecision attribute)
S
sensor (trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
set_headlight_color() (trainlib_async.Train method)
set_next_split_steering_decision() (trainlib_async.Train method)
set_snap_command_execution() (trainlib_async.Train method)
set_snap_command_feedback() (trainlib_async.Train method)
set_top_led_color() (trainlib_async.Train method)
SHORT (trainlib_async.enums.ButtonPress attribute)
snap_counter (trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
SnapColorValue (class in trainlib_async.enums)
SnapCommand (class in trainlib_async.messages)
speed_cmps (trainlib_async.messages.TrainMsgMovement attribute)
speed_control (trainlib_async.messages.TrainMsgMovement attribute)
SpeedLevel (class in trainlib_async.enums)
start_with() (trainlib_async.messages.SnapCommand method)
starts_with() (trainlib_async.messages.SnapCommand method)
STEER (trainlib_async.enums.SteeringDecision attribute)
SteeringDecision (class in trainlib_async.enums)
STOP (trainlib_async.enums.MovementDirection attribute)
(trainlib_async.enums.SpeedLevel attribute)
stop_driving() (trainlib_async.Train method)
StopDrivingFeedbackType (class in trainlib_async.enums)
STRAIGHT (trainlib_async.enums.SteeringDecision attribute)
T
timestamp_ms (trainlib_async.messages.TrainMsgEventBackColorChanged attribute)
(trainlib_async.messages.TrainMsgEventBase attribute)
(trainlib_async.messages.TrainMsgEventButtonPressDetected attribute)
(trainlib_async.messages.TrainMsgEventChargingStateChanged attribute)
(trainlib_async.messages.TrainMsgEventFrontColorChanged attribute)
(trainlib_async.messages.TrainMsgEventLowBattery attribute)
(trainlib_async.messages.TrainMsgEventMovementDirectionChanged attribute)
(trainlib_async.messages.TrainMsgEventSensorColorChangedBase attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandDetected attribute)
(trainlib_async.messages.TrainMsgEventSnapCommandExecuted attribute)
(trainlib_async.messages.TrainMsgEventSplitDecision attribute)
(trainlib_async.messages.TrainMsgEventUnknown attribute)
to_rgb_bytes() (trainlib_async.enums.SnapColorValue method)
Train (class in trainlib_async)
TrainCommandError
trainlib_async
module
trainlib_async.enums
module
trainlib_async.exc
module
TrainlibError
TrainMessageInterpretationError
TrainMessageLengthError
TrainMessageTypeError
TrainMsg (in module trainlib_async.messages)
TrainMsgBase (class in trainlib_async.messages)
TrainMsgEvent (in module trainlib_async.messages)
TrainMsgEventBackColorChanged (class in trainlib_async.messages)
TrainMsgEventBase (class in trainlib_async.messages)
TrainMsgEventButtonPressDetected (class in trainlib_async.messages)
TrainMsgEventChargingStateChanged (class in trainlib_async.messages)
TrainMsgEventFrontColorChanged (class in trainlib_async.messages)
TrainMsgEventLowBattery (class in trainlib_async.messages)
TrainMsgEventMovementDirectionChanged (class in trainlib_async.messages)
TrainMsgEventSensorColorChanged (in module trainlib_async.messages)
TrainMsgEventSensorColorChangedBase (class in trainlib_async.messages)
TrainMsgEventSnapCommandDetected (class in trainlib_async.messages)
TrainMsgEventSnapCommandExecuted (class in trainlib_async.messages)
TrainMsgEventSplitDecision (class in trainlib_async.messages)
TrainMsgEventUnknown (class in trainlib_async.messages)
TrainMsgMacAddress (class in trainlib_async.messages)
TrainMsgMalformed (class in trainlib_async.messages)
TrainMsgMovement (class in trainlib_async.messages)
TrainMsgStatsLifetimeOdometer (class in trainlib_async.messages)
TrainMsgTrainUuid (class in trainlib_async.messages)
TrainMsgUnknown (class in trainlib_async.messages)
TrainMsgVersionDetail (class in trainlib_async.messages)
TrainMsgVersionDetail.Version (class in trainlib_async.messages)
TrainNotConnectedError
TrainNotFoundError
TrainScanner (class in trainlib_async)
U
UNKNOWN (trainlib_async.enums.SnapColorValue attribute)
uuid (trainlib_async.messages.TrainMsgTrainUuid attribute)
W
WHITE (trainlib_async.enums.SnapColorValue attribute)
writes (trainlib_async.Train property)
Y
YELLOW (trainlib_async.enums.SnapColorValue attribute)
Read the Docs
v: v1.0.1
Versions
latest
stable
v1.0.1
v1.0.0
Downloads
On Read the Docs
Project Home
Builds