v3.2.0

Arduino/Examples/Home_Assistant/Home_Assistant.ino

@@ -1,25 +1,27 @@
 /* 
    Home_Assistant.ino
-   
-   Example code for sending environment data from the Metriful MS430 to
-   an installation of Home Assistant on your local WiFi network.
-   For more information, visit www.home-assistant.io
+
+   An example of using HTTP POST requests to send environment data
+   from the Metriful MS430 to an installation of Home Assistant on
+   your local WiFi network. This does not use ESPHome.
 
    This example is designed for the following WiFi enabled hosts:
    * Arduino Nano 33 IoT
    * Arduino MKR WiFi 1010
    * ESP8266 boards (e.g. Wemos D1, NodeMCU)
    * ESP32 boards (e.g. DOIT DevKit v1)
-   
-   Data are sent at regular intervals over your WiFi network to Home 
-   Assistant and can be viewed on the dashboard or used to control 
-   home automation tasks. More setup information is provided in the 
-   Readme and User Guide.
+   * Raspberry Pi Pico W
+   The non-Arduino boards can also use the separate ESPHome method.
+
+   Data are sent at regular intervals over your WiFi network to Home
+   Assistant and can be viewed on the dashboard or used to control
+   home automation tasks. More setup information is provided in the
+   Readme.
 
-   Copyright 2020 Metriful Ltd. 
+   Copyright 2020-2023 Metriful Ltd.
    Licensed under the MIT License - for further details see LICENSE.txt
 
-   For code examples, datasheet and user guide, visit 
+   For code examples, datasheet and user guide, visit
    https://github.com/metriful/sensor
 */
 
@@ -32,9 +34,9 @@
 // How often to read and report the data (every 3, 100 or 300 seconds)
 uint8_t cycle_period = CYCLE_PERIOD_100_S;
 
-// The details of the WiFi network:
-char SSID[] = "PUT WIFI NETWORK NAME HERE IN QUOTES"; // network SSID (name)
-char password[] = "PUT WIFI PASSWORD HERE IN QUOTES"; // network password
+// The details of your WiFi network:
+const char * SSID = "PUT WIFI NETWORK NAME HERE"; // network SSID (name)
+const char * password = "PUT WIFI PASSWORD HERE";
 
 // Home Assistant settings
 
@@ -47,9 +49,9 @@ char password[] = "PUT WIFI PASSWORD HERE IN QUOTES"; // network password
 
 // Change this to the IP address of the computer running Home Assistant. 
 // You can find this from the admin interface of your router.
-#define HOME_ASSISTANT_IP "192.168.43.144"
+#define HOME_ASSISTANT_IP "192.168.1.152"
 
-// Security access token: the Readme and User Guide explain how to get this
+// Security access token: the Readme explains how to get this
 #define LONG_LIVED_ACCESS_TOKEN "PASTE YOUR TOKEN HERE WITHIN QUOTES"
 
 // END OF USER-EDITABLE SETTINGS
@@ -62,8 +64,8 @@ char password[] = "PUT WIFI PASSWORD HERE IN QUOTES"; // network password
 WiFiClient client;
 
 // Buffers for assembling http POST requests
-char postBuffer[450] = {0};
-char fieldBuffer[70] = {0};
+char postBuffer[500] = {0};
+char fieldBuffer[200] = {0};
 
 // Structs for data
 AirData_t airData = {0};
@@ -72,32 +74,42 @@ LightData_t lightData = {0};
 ParticleData_t particleData = {0};
 SoundData_t soundData = {0};
 
-// Define the display attributes of data sent to Home Assistant. 
+// Define the display attributes of data to send to Home Assistant. 
 // The chosen name, unit and icon will appear in on the overview 
-// dashboard in Home Assistant. The icons can be chosen from 
-// https://cdn.materialdesignicons.com/5.3.45/    
-// (remove the "mdi-" part from the icon name).
+// dashboard in Home Assistant. The icons can be chosen at
+// https://pictogrammers.com/library/mdi/
 // The attribute fields are: {name, unit, icon, decimal places}
-HA_Attributes_t pressure = {"Pressure","Pa","weather-cloudy",0};
-HA_Attributes_t humidity = {"Humidity","%","water-percent",1};
-HA_Attributes_t illuminance = {"Illuminance","lx","white-balance-sunny",2};
-HA_Attributes_t soundLevel = {"Sound level","dBA","microphone",1};
-HA_Attributes_t peakAmplitude = {"Sound peak","mPa","waveform",2};
-HA_Attributes_t AQI = {"Air Quality Index"," ","thought-bubble-outline",1};
-HA_Attributes_t AQ_assessment = {"Air quality assessment","","flower-tulip",0};
+HA_Attributes_t pressure = {"Air pressure", "Pa", "weather-partly-rainy", 0};
+HA_Attributes_t humidity = {"Humidity", "%", "cloud-percent", 1};
+HA_Attributes_t illuminance = {"Illuminance", "lux", "white-balance-sunny", 2};
+HA_Attributes_t white_light = {"White light level", "", "circle-outline", 0};
+HA_Attributes_t soundLevel = {"Sound pressure level", "dBA", "microphone", 1};
+HA_Attributes_t peakAmplitude = {"Peak sound amplitude", "mPa", "waveform", 2};
+HA_Attributes_t AQI = {"Air Quality Index", "", "flower-tulip-outline", 1};
+HA_Attributes_t AQ_assessment = {"Air quality", "", "flower-tulip-outline", 0};
+HA_Attributes_t AQ_accuracy = {"Air quality accuracy", "", "magnify", 0};
+HA_Attributes_t gas_resistance = {"Gas sensor resistance", OHM_SYMBOL, "scent", 0};
 #if (PARTICLE_SENSOR == PARTICLE_SENSOR_PPD42)
-  HA_Attributes_t particulates = {"Particle concentration","ppL","chart-bubble",0};
+  HA_Attributes_t particulates = {"Particle concentration", "ppL", "chart-bubble", 0};
 #else
-  HA_Attributes_t particulates = {"Particle concentration",SDS011_UNIT_SYMBOL,"chart-bubble",2};
+  HA_Attributes_t particulates = {"Particle concentration", SDS011_UNIT_SYMBOL,
+                                  "chart-bubble", 2};
 #endif
 #ifdef USE_FAHRENHEIT
-  HA_Attributes_t temperature = {"Temperature",FAHRENHEIT_SYMBOL,"thermometer",1};
+  HA_Attributes_t temperature = {"Temperature", FAHRENHEIT_SYMBOL, "thermometer", 1};
 #else
-  HA_Attributes_t temperature = {"Temperature",CELSIUS_SYMBOL,"thermometer",1};
+  HA_Attributes_t temperature = {"Temperature", CELSIUS_SYMBOL, "thermometer", 1};
 #endif
+HA_Attributes_t soundBands[SOUND_FREQ_BANDS] = {{"SPL at 125 Hz", "dB", "sine-wave", 1},
+                                                {"SPL at 250 Hz", "dB", "sine-wave", 1},
+                                                {"SPL at 500 Hz", "dB", "sine-wave", 1},
+                                                {"SPL at 1000 Hz", "dB", "sine-wave", 1},
+                                                {"SPL at 2000 Hz", "dB", "sine-wave", 1},
+                                                {"SPL at 4000 Hz", "dB", "sine-wave", 1}};
 
 
-void setup() {
+void setup()
+{
   // Initialize the host's pins, set up the serial port and reset:
   SensorHardwareSetup(I2C_ADDRESS); 
 
@@ -112,24 +124,27 @@ void setup() {
 }
 
 
-void loop() {
-
+void loop()
+{
   // Wait for the next new data release, indicated by a falling edge on READY
-  while (!ready_assertion_event) {
+  while (!ready_assertion_event)
+  {
     yield();
   }
   ready_assertion_event = false;
 
   // Read data from the MS430 into the data structs. 
   ReceiveI2C(I2C_ADDRESS, AIR_DATA_READ, (uint8_t *) &airData, AIR_DATA_BYTES);
-  ReceiveI2C(I2C_ADDRESS, AIR_QUALITY_DATA_READ, (uint8_t *) &airQualityData, AIR_QUALITY_DATA_BYTES);
+  ReceiveI2C(I2C_ADDRESS, AIR_QUALITY_DATA_READ, (uint8_t *) &airQualityData,
+             AIR_QUALITY_DATA_BYTES);
   ReceiveI2C(I2C_ADDRESS, LIGHT_DATA_READ, (uint8_t *) &lightData, LIGHT_DATA_BYTES);
   ReceiveI2C(I2C_ADDRESS, SOUND_DATA_READ, (uint8_t *) &soundData, SOUND_DATA_BYTES);
   ReceiveI2C(I2C_ADDRESS, PARTICLE_DATA_READ, (uint8_t *) &particleData, PARTICLE_DATA_BYTES);
 
   // Check that WiFi is still connected
   uint8_t wifiStatus = WiFi.status();
-  if (wifiStatus != WL_CONNECTED) {
+  if (wifiStatus != WL_CONNECTED)
+  {
     // There is a problem with the WiFi connection: attempt to reconnect.
     Serial.print("Wifi status: ");
     Serial.println(interpret_WiFi_status(wifiStatus));
@@ -146,73 +161,93 @@ void loop() {
   sendNumericData(&temperature, (uint32_t) T_intPart, T_fractionalPart, isPositive);
   sendNumericData(&pressure, (uint32_t) airData.P_Pa, 0, true);
   sendNumericData(&humidity, (uint32_t) airData.H_pc_int, airData.H_pc_fr_1dp, true);
-  sendNumericData(&illuminance, (uint32_t) lightData.illum_lux_int, lightData.illum_lux_fr_2dp, true);
+  sendNumericData(&gas_resistance, airData.G_ohm, 0, true);
+  sendNumericData(&illuminance, (uint32_t) lightData.illum_lux_int,
+                  lightData.illum_lux_fr_2dp, true);
+  sendNumericData(&white_light, (uint32_t) lightData.white, 0, true);
   sendNumericData(&soundLevel, (uint32_t) soundData.SPL_dBA_int, soundData.SPL_dBA_fr_1dp, true);
   sendNumericData(&peakAmplitude, (uint32_t) soundData.peak_amp_mPa_int, 
                   soundData.peak_amp_mPa_fr_2dp, true);
   sendNumericData(&AQI, (uint32_t) airQualityData.AQI_int, airQualityData.AQI_fr_1dp, true);
-  if (PARTICLE_SENSOR != PARTICLE_SENSOR_OFF) {
+  if (PARTICLE_SENSOR != PARTICLE_SENSOR_OFF)
+  {
     sendNumericData(&particulates, (uint32_t) particleData.concentration_int, 
                     particleData.concentration_fr_2dp, true);
   }
   sendTextData(&AQ_assessment, interpret_AQI_value(airQualityData.AQI_int));
+  sendTextData(&AQ_accuracy, interpret_AQI_accuracy_brief(airQualityData.AQI_accuracy));
+  for (uint8_t i = 0; i < SOUND_FREQ_BANDS; i++)
+  {
+    sendNumericData(&soundBands[i], (uint32_t) soundData.SPL_bands_dB_int[i],
+                    soundData.SPL_bands_dB_fr_1dp[i], true);
+  }
 }
 
 // Send numeric data with specified sign, integer and fractional parts
 void sendNumericData(const HA_Attributes_t * attributes, uint32_t valueInteger, 
-                             uint8_t valueDecimal, bool isPositive) {
+                     uint8_t valueDecimal, bool isPositive)
+{
   char valueText[20] = {0};
   const char * sign = isPositive ? "" : "-";
-  switch (attributes->decimalPlaces) {
+  switch (attributes->decimalPlaces)
+  {
     case 0:
     default:
-      sprintf(valueText,"%s%" PRIu32, sign, valueInteger);
+      snprintf(valueText, sizeof valueText, "%s%" PRIu32, sign, valueInteger);
       break;
     case 1:
-      sprintf(valueText,"%s%" PRIu32 ".%u", sign, valueInteger, valueDecimal);
+      snprintf(valueText, sizeof valueText, "%s%" PRIu32 ".%u", sign,
+               valueInteger, valueDecimal);
       break;
     case 2:
-      sprintf(valueText,"%s%" PRIu32 ".%02u", sign, valueInteger, valueDecimal);
+      snprintf(valueText, sizeof valueText, "%s%" PRIu32 ".%02u", sign,
+               valueInteger, valueDecimal);
       break;
   }
   http_POST_Home_Assistant(attributes, valueText);
 }
 
-// Send a text string: must have quotation marks added
-void sendTextData(const HA_Attributes_t * attributes, const char * valueText) {
+// Send a text string: must have quotation marks added.
+void sendTextData(const HA_Attributes_t * attributes, const char * valueText)
+{
   char quotedText[20] = {0};
-  sprintf(quotedText,"\"%s\"", valueText);
+  snprintf(quotedText, sizeof quotedText, "\"%s\"", valueText);
   http_POST_Home_Assistant(attributes, quotedText);
 }
 
 // Send the data to Home Assistant as an HTTP POST request.
-void http_POST_Home_Assistant(const HA_Attributes_t * attributes, const char * valueText) {
+void http_POST_Home_Assistant(const HA_Attributes_t * attributes, const char * valueText)
+{
   client.stop();
-  if (client.connect(HOME_ASSISTANT_IP, 8123)) {
-    // Form the URL from the name but replace spaces with underscores
-    strcpy(fieldBuffer,attributes->name);
-    for (uint8_t i=0; i<strlen(fieldBuffer); i++) {
-      if (fieldBuffer[i] == ' ') {
+  if (client.connect(HOME_ASSISTANT_IP, 8123))
+  {
+    // Form the entity_id from the variable name but replace spaces with underscores
+    snprintf(fieldBuffer, sizeof fieldBuffer, SENSOR_NAME ".%s", attributes->name);
+    for (uint8_t i = 0; i < strlen(fieldBuffer); i++)
+    {
+      if (fieldBuffer[i] == ' ')
+      {
         fieldBuffer[i] = '_';
       }
     }
-    sprintf(postBuffer,"POST /api/states/" SENSOR_NAME ".%s HTTP/1.1", fieldBuffer);
+    snprintf(postBuffer, sizeof postBuffer, "POST /api/states/%s HTTP/1.1", fieldBuffer);
     client.println(postBuffer);
     client.println("Host: " HOME_ASSISTANT_IP ":8123");
     client.println("Content-Type: application/json");
     client.println("Authorization: Bearer " LONG_LIVED_ACCESS_TOKEN);
-    
+
     // Assemble the JSON content string:
-    sprintf(postBuffer,"{\"state\":%s,\"attributes\":{\"unit_of_measurement\""
-                       ":\"%s\",\"friendly_name\":\"%s\",\"icon\":\"mdi:%s\"}}",
-                       valueText, attributes->unit, attributes->name, attributes->icon);
-    
-    sprintf(fieldBuffer,"Content-Length: %u", strlen(postBuffer));  
+    snprintf(postBuffer, sizeof postBuffer, "{\"state\":%s,\"attributes\":"
+             "{\"unit_of_measurement\":\"%s\",\"friendly_name\":\"%s\",\"icon\":\"mdi:%s\"}}",
+             valueText, attributes->unit, attributes->name, attributes->icon);
+
+    snprintf(fieldBuffer, sizeof fieldBuffer, "Content-Length: %u", strlen(postBuffer));
     client.println(fieldBuffer);
     client.println();
     client.print(postBuffer);
   }
-  else {
+  else
+  {
     Serial.println("Client connection failed.");
   }
 }