only:sensor.h comment

This commit is contained in:
Matthew Kennedy 2024-12-15 16:19:51 -08:00 committed by rusefillc
parent 4a356d4fe6
commit f048161b7d
1 changed files with 1 additions and 10 deletions

View File

@ -14,16 +14,7 @@
* configure it if necessary, and call its Register() function if it should be enabled.
* See init_oil_pressure.cpp for a minimal example.
*
* 3. Consume the new sensor with instance(s) of SensorConsumer<SensorType::MyNewSensor>
*
* Consumers:
*
* tl;dr: Use a SensorConsumer. See sensor_consumer.h
*
* All a consumer does is look up whether a particular sensor is present in the table,
* and if so, asks it for the current reading. This could synchronously perform sensor
* acquisition and conversion (not recommended), or use a previously stored value (recommended!).
* This functionality is implemented in sensor_consumer.h, and sensor.cpp.
* 3. Consume the new sensor with Sensor::get(SensorType::MyNewSensor)
*
* Providers:
* Instantiate a subclass of Sensor, and implement the Get() function.