Raxol.Sensor.Behaviour behaviour (Raxol v2.3.0)

Behaviour for sensor implementations.

Sensors produce readings at a configurable sample rate. Each reading contains timestamped values with a quality indicator.

Summary

connect(opts)

read(state)

sample_rate()

Sample rate in milliseconds. Defaults to 100ms.

@callback connect(opts :: keyword()) :: {:ok, term()} | {:error, term()}

@callback disconnect(state :: term()) :: :ok

@callback read(state :: term()) ::
  {:ok, Raxol.Sensor.Reading.t(), term()} | {:error, term()}

(optional)

@callback sample_rate() :: pos_integer()

Sample rate in milliseconds. Defaults to 100ms.