OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
navigation.navigation_sensor_if.NavigationSensorIf Class Reference

Provide normalized motion samples to the navigation controller. More...

Inherits ABC.

Public Member Functions

bool is_connected (self)
 Return whether the motion sensor is connected and ready.
 
None connect (self)
 Connect to the motion sensor.
 
None disconnect (self)
 Disconnect from the motion sensor.
 
MotionSample read_motion (self)
 Read one normalized motion sample.
 

Detailed Description

Provide normalized motion samples to the navigation controller.

Member Function Documentation

◆ is_connected()

bool navigation.navigation_sensor_if.NavigationSensorIf.is_connected (   self)

Return whether the motion sensor is connected and ready.

Return values
TrueThe sensor can provide motion samples.
FalseThe sensor is disconnected.

◆ read_motion()

MotionSample navigation.navigation_sensor_if.NavigationSensorIf.read_motion (   self)

Read one normalized motion sample.

Returns
Acceleration in m/s² and angular velocity in rad/s.

The documentation for this class was generated from the following file: