jacdac.planar_position

Submodules

Package Contents

Classes

PlanarPositionClient

A sensor that repors 2D position, typically an optical mouse tracking sensor.
class jacdac.planar_position.PlanarPositionClient(bus: jacdac.bus.Bus, role: str, *, missing_position_value: Tuple[float, float] | None = None)

Bases: jacdac.bus.SensorClient

A sensor that repors 2D position, typically an optical mouse tracking sensor.

  • The sensor starts at an arbitrary origin (0,0) and reports the distance from that origin.

  • The streaming_interval is respected when the position is changing. When the position is not changing, the streaming interval may be throttled to 500ms.

Implements a client for the Planar position service.

property position: Tuple[float, float] | None

The current position of the sensor., x: mm,y: mm

property variant: jacdac.planar_position.constants.PlanarPositionVariant | None

(Optional) Specifies the type of physical sensor.,