b2op-hub-micropython

MicroPython on the B2OP Hub.

This documentation covers the Python programming API exposed to user scripts running on the hub — the hub and lpf2 modules and their sub-modules.

More info about the hub: b2op.com.

Getting started

• Quickstart
  • Minimal program
  • What the modules do
• Examples
  • Distance sensor
  • Dumb-car (two motors + remote)
  • Port expander
  • IMU
  • LCD (LVGL)
  • BLE remote hub
  • Grove I2C (MPU-6050)
  • NeoPixel on a repurposed LPF2 port
  • Project folder

Hub module

• The hub module
  • Top-level members
  • Reference
• Ports
  • Members
  • Lifecycle
  • Pausing a port
  • Reading sensor values
  • Wrapped built-in ports
• Hub LED
• IMU
  • Attitude
  • Raw samples
  • Calibration
  • Example loop
• Buttons
  • Level readers
  • Callbacks
  • Stopping callbacks
  • Exiting a program
  • Power-off
• LCD
  • Init
  • Rendering loop
  • Backlight
  • Raw panel access
  • Soft reset
• Audio
  • Overview
  • Synthesis
  • Melody playback
  • MIDI file playback
  • File playback
  • Stopping playback
• I2C (Grove connector)
  • Quickstart
  • Raw write / read
  • Register access
  • Full example — MPU-6050 accelerometer on Grove
  • API reference
• Board constants
  • Logical pins and buses
  • Buses
  • Peripheral chips
  • Subsystems
  • SD card
  • Port pins
• Program lifecycle
  • Run program menu
  • Running a program
  • Exiting a program
  • Powering off
  • Background tasks
  • Log level
• Host protocol framing
  • Wire format
  • Kind table
  • Protocol versioning
  • Structured payloads
  • Streaming transfers
  • UPLOAD flow
  • READ flow
  • CP flow
  • ABORT
  • MKDIR
  • Unknown kinds
  • Sequence / response matching
  • Fire-and-forget ordering (NO_ACK)
  • HELLO lifecycle
  • Keepalive ping
  • Why the C-level stdout hook
  • Transport fan-out
  • Interactive frames (0x34–0x35)
  • Serial monitor
  • Notes

LPF2 module

• The lpf2 module
  • Layout
  • Design notes
• Ports
  • Lifecycle & polling
  • Forcing a device type (local ports only)
  • Detecting a device
  • Mode selection
  • Direct motor commands
  • Introspection
  • Raw I/O
  • Slave / device-side port (emulated_port)
• Devices
  • Common methods
  • Registering factories
• Motors
  • Conventions
  • Open-loop power
  • Continuous speed
  • Timed moves
  • Relative-degree moves
  • Absolute position
  • Ramp profiles
  • Motor tuning presets
• Sensors
  • Colour sensor
  • Distance sensor
  • Colour + distance (legacy)
  • Built-in inertial sensors
• Virtual devices
  • The pieces
  • Building a descriptor
  • Subclassing device
  • Attaching and running
  • GC pitfalls
• Hub emulation
  • Typical setup
  • Runtime updates
  • Stop
  • Lifetime
• Remote hub (BLE client)
  • Basic pattern
  • Ports on the remote hub
  • Manual port configuration
  • Hub properties
  • State flags
  • Shutdown
• Battery
  • Voltage window
  • Manual voltage updates
  • Custom percent mapping
  • Built-in ADC reader
• Enumerations
  • lpf2.color
  • lpf2.device_type
  • lpf2.hub_type
  • lpf2.alerts
  • lpf2.battery_type
  • lpf2.button_state
  • lpf2.hub_property
  • lpf2.port_num
• Port expander
  • Sub-port numbering
  • Client side
  • Server side

Reference

• hub
  • Submodules
  • Attributes
  • Functions
  • Package Contents
• lpf2
  • Submodules
  • Classes
  • Package Contents
• machine
  • Attributes
  • Classes
  • Functions
  • Module Contents

Indices

• Index

• Module Index

• Search Page