stable

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
      • TrainScanner
        • TrainScanner.__init__()
        • TrainScanner.get_train()
        • TrainScanner.get_trains()
    • 2. Train
      • Train
        • Train.id
        • Train.name
        • Train.alias
        • Train.connection_status
        • Train.is_connected
        • Train.notifications
        • Train.writes
        • Train.connect()
        • Train.disconnect()
        • Train.get_mac_address()
        • Train.get_uuid()
        • Train.get_version_info()
        • Train.get_stats_lifetime_odometer()
        • Train.drive_at_speed()
        • Train.drive_at_speed_level()
        • Train.drive_with_constant_pwm()
        • Train.stop_driving()
        • Train.pause_driving()
        • Train.set_next_split_steering_decision()
        • Train.set_top_led_color()
        • Train.set_headlight_color()
        • Train.get_movement_notification()
        • Train.movement_notification_stream()
        • Train.set_snap_command_feedback()
        • Train.set_snap_command_execution()
        • Train.clear_custom_snap_commands()
        • Train.decouple_wagon()
    • 3. Enums (constants)
      • ButtonPress
        • ButtonPress.SHORT
        • ButtonPress.LONG
      • ColorSensor
        • ColorSensor.FRONT
        • ColorSensor.BACK
      • MovementDirection
        • MovementDirection.CURRENT
        • MovementDirection.FORWARD
        • MovementDirection.BACKWARD
        • MovementDirection.STOP
        • MovementDirection.INVERT
      • SnapColorValue
        • SnapColorValue.to_rgb_bytes()
        • SnapColorValue.random()
        • SnapColorValue.BLACK
        • SnapColorValue.RED
        • SnapColorValue.GREEN
        • SnapColorValue.BLUE
        • SnapColorValue.YELLOW
        • SnapColorValue.MAGENTA
        • SnapColorValue.CYAN
        • SnapColorValue.WHITE
        • SnapColorValue.UNKNOWN
      • SpeedLevel
        • SpeedLevel.STOP
        • SpeedLevel.LEVEL1
        • SpeedLevel.LEVEL2
        • SpeedLevel.LEVEL3
      • SteeringDecision
        • SteeringDecision.NONE
        • SteeringDecision.LEFT
        • SteeringDecision.RIGHT
        • SteeringDecision.STRAIGHT
        • SteeringDecision.STEER
        • SteeringDecision.ALL
      • StopDrivingFeedbackType
        • StopDrivingFeedbackType.NONE
        • StopDrivingFeedbackType.MOVEMENT_STOP
        • StopDrivingFeedbackType.END_ROUTE
    • 4. Messages (from the train)
      • 4.1. Base classes
        • TrainMsgBase
          • TrainMsgBase.command_id
          • TrainMsgBase.raw_packet
        • TrainMsgEventBase
          • TrainMsgEventBase.command_id
          • TrainMsgEventBase.event_id
          • TrainMsgEventBase.timestamp_ms
          • TrainMsgEventBase.raw_packet
        • TrainMsgEventSensorColorChangedBase
          • TrainMsgEventSensorColorChangedBase.sensor
          • TrainMsgEventSensorColorChangedBase.color
          • TrainMsgEventSensorColorChangedBase.command_id
          • TrainMsgEventSensorColorChangedBase.event_id
          • TrainMsgEventSensorColorChangedBase.timestamp_ms
          • TrainMsgEventSensorColorChangedBase.raw_packet
      • 4.2. Response messages
        • TrainMsgMacAddress
          • TrainMsgMacAddress.command_id
          • TrainMsgMacAddress.mac_address
          • TrainMsgMacAddress.raw_packet
        • TrainMsgTrainUuid
          • TrainMsgTrainUuid.command_id
          • TrainMsgTrainUuid.uuid
          • TrainMsgTrainUuid.raw_packet
        • TrainMsgVersionDetail
          • TrainMsgVersionDetail.Version
          • TrainMsgVersionDetail.command_id
          • TrainMsgVersionDetail.ble_api_version
          • TrainMsgVersionDetail.fw_version
          • TrainMsgVersionDetail.raw_packet
        • TrainMsgStatsLifetimeOdometer
          • TrainMsgStatsLifetimeOdometer.command_id
          • TrainMsgStatsLifetimeOdometer.lifetime_odometer_meters
          • TrainMsgStatsLifetimeOdometer.raw_packet
        • TrainMsgMovement
          • TrainMsgMovement.command_id
          • TrainMsgMovement.direction
          • TrainMsgMovement.speed_cmps
          • TrainMsgMovement.pwm
          • TrainMsgMovement.speed_control
          • TrainMsgMovement.desired_speed_cmps
          • TrainMsgMovement.pause_time_ms
          • TrainMsgMovement.next_split_decision
          • TrainMsgMovement.lifetime_odometer_meters
          • TrainMsgMovement.raw_packet
      • 4.3. Event messages
        • TrainMsgEventMovementDirectionChanged
          • TrainMsgEventMovementDirectionChanged.event_id
          • TrainMsgEventMovementDirectionChanged.direction
          • TrainMsgEventMovementDirectionChanged.command_id
          • TrainMsgEventMovementDirectionChanged.timestamp_ms
          • TrainMsgEventMovementDirectionChanged.raw_packet
        • TrainMsgEventLowBattery
          • TrainMsgEventLowBattery.event_id
          • TrainMsgEventLowBattery.command_id
          • TrainMsgEventLowBattery.timestamp_ms
          • TrainMsgEventLowBattery.raw_packet
        • TrainMsgEventChargingStateChanged
          • TrainMsgEventChargingStateChanged.event_id
          • TrainMsgEventChargingStateChanged.is_charging
          • TrainMsgEventChargingStateChanged.command_id
          • TrainMsgEventChargingStateChanged.timestamp_ms
          • TrainMsgEventChargingStateChanged.raw_packet
        • TrainMsgEventButtonPressDetected
          • TrainMsgEventButtonPressDetected.event_id
          • TrainMsgEventButtonPressDetected.button_press_type
          • TrainMsgEventButtonPressDetected.command_id
          • TrainMsgEventButtonPressDetected.timestamp_ms
          • TrainMsgEventButtonPressDetected.raw_packet
        • TrainMsgEventSnapCommandDetected
          • TrainMsgEventSnapCommandDetected.event_id
          • TrainMsgEventSnapCommandDetected.snap_counter
          • TrainMsgEventSnapCommandDetected.colors
          • TrainMsgEventSnapCommandDetected.command_id
          • TrainMsgEventSnapCommandDetected.timestamp_ms
          • TrainMsgEventSnapCommandDetected.raw_packet
        • TrainMsgEventSnapCommandExecuted
          • TrainMsgEventSnapCommandExecuted.event_id
          • TrainMsgEventSnapCommandExecuted.snap_counter
          • TrainMsgEventSnapCommandExecuted.colors
          • TrainMsgEventSnapCommandExecuted.command_id
          • TrainMsgEventSnapCommandExecuted.timestamp_ms
          • TrainMsgEventSnapCommandExecuted.raw_packet
        • TrainMsgEventFrontColorChanged
          • TrainMsgEventFrontColorChanged.event_id
          • TrainMsgEventFrontColorChanged.sensor
          • TrainMsgEventFrontColorChanged.command_id
          • TrainMsgEventFrontColorChanged.color
          • TrainMsgEventFrontColorChanged.timestamp_ms
          • TrainMsgEventFrontColorChanged.raw_packet
        • TrainMsgEventBackColorChanged
          • TrainMsgEventBackColorChanged.event_id
          • TrainMsgEventBackColorChanged.sensor
          • TrainMsgEventBackColorChanged.command_id
          • TrainMsgEventBackColorChanged.color
          • TrainMsgEventBackColorChanged.timestamp_ms
          • TrainMsgEventBackColorChanged.raw_packet
        • TrainMsgEventSplitDecision
          • TrainMsgEventSplitDecision.event_id
          • TrainMsgEventSplitDecision.decision
          • TrainMsgEventSplitDecision.command_id
          • TrainMsgEventSplitDecision.timestamp_ms
          • TrainMsgEventSplitDecision.raw_packet
      • 4.4. Error messages
        • TrainMsgUnknown
          • TrainMsgUnknown.command_id
          • TrainMsgUnknown.raw_packet
        • TrainMsgEventUnknown
          • TrainMsgEventUnknown.command_id
          • TrainMsgEventUnknown.event_id
          • TrainMsgEventUnknown.timestamp_ms
          • TrainMsgEventUnknown.raw_packet
        • TrainMsgMalformed
          • TrainMsgMalformed.command_id
          • TrainMsgMalformed.raw_packet
      • 4.5. Union classes
        • TrainMsg
        • TrainMsgEvent
        • TrainMsgEventSensorColorChanged
    • 5. Exceptions
      • TrainlibError
      • TrainNotFoundError
      • TrainNotConnectedError
      • TrainMessageTypeError
      • TrainMessageLengthError
      • TrainMessageInterpretationError
      • TrainCommandError
    • 6. Other noteworthy APIs
      • SnapCommand
        • SnapCommand.__eq__()
        • SnapCommand.start_with()
        • SnapCommand.starts_with()
      • AsyncObserver

OTHER

  • Issues and Requests
  • Intelino Public License
intelino-trainlib-async-py
  • Search

© Copyright 2021, intelino. Revision 68d0c59a.

Built with Sphinx using a theme provided by Read the Docs.