Humidity
Device Compatibility
Overview
The Humidity driver allows for:
- Reading relative humidity on the board
- Obtaining temperature in Celsius and raw values
- Calibrating temperature
Available ZeroMQ Ports
Base port: 20017Keep-alive port: 20018Error port: 20019Data update port: 20020
Protocol
Base Port
This port accepts three configurations for communicating with the Humidity driver.
-
delay_between_updates- controls the output speed of messages from the Data Update port. -
timeout_after_last_ping- stops sending messages from the Data Update port if nothing has been sent to the Keep-alive port after the specified amount of seconds. -
humidity- the humidity configuration that's created from aHumidityParamsmessage.
message DriverConfig { // Delay between updates in seconds float delay_between_updates = 1; // Timeout after last ping float timeout_after_last_ping = 2; // Humidity configuration matrix_io.malos.v1.sense.HumidityParams humidity = 9;
HumidityParams
current_temperature- a reference of the current temperature for calibration.
message HumidityParams{ // Current temperature Celsius used for calibration. float current_temperature = 1; }
Keep-alive Port
This driver needs keep-alive messages in order to send data to your application. It's recommended to send an empty string "" because the contents of a keep-alive message are never read.
Error Port
Applications can subscribe to this port to receive driver related errors.
Data Update Port
Applications can subscribe to this port for humidity data. The output will be a serialized message of type Humidity with the following information.
message Humidity { // Humidity float humidity = 1; // Temperature float temperature = 2; // Raw temperature value from the sensor float temperature_raw = 3; // Flag that tells if the temperature is calibrated bool temperature_is_calibrated = 4; }