refactor(zigbee): changed class name to ZigbeeIlluminanceSensor

Author: MikaFromTheRoof

libraries/Zigbee/examples/Zigbee_Light_Sensor/README.md

@@ -1,6 +1,6 @@
-# Arduino-ESP32 Zigbee Light Sensor Sleepy Device Example
+# Arduino-ESP32 Zigbee Illuminance Sensor Example
 
-This example demonstrates how to use the Zigbee library to create an end device light sensor and use it as a Home Automation (HA) extended light sensor.
+This example demonstrates how to use the Zigbee library to create an end device illuminance sensor and use it as a Home Automation (HA) extended illuminance sensor.
 
 # Supported Targets
 
@@ -9,9 +9,9 @@ Currently, this example supports the following targets.
 | Supported Targets | ESP32-C6 | ESP32-H2 |
 | ----------------- | -------- | -------- |
 
-## Light Sensor Functions
+## Illuminance Sensor Functions
 
-1. Initialize a Zigbee light sensor.
+1. Initialize a Zigbee illuminance sensor.
 2. Measure illuminance value.
 3. Report the measured value to the Zigbee network.
 
@@ -25,7 +25,7 @@ Currently, this example supports the following targets.
 
 In this example the raw analog value of a light sensor is used to calculate illuminance.
 Alter the calculation according to your use case and calibrate it to receive correct lux values.
-Set the light sensor GPIO by changing the `light_sensor_pin` variable to the pin to the pin to which your sensor is connected.
+Set the illuminance sensor GPIO by changing the `illuminance_sensor_pin` variable to the pin to the pin to which your sensor is connected.
 Set the button GPIO by changing the `button` variable. By default, it's the pin `BOOT_PIN` (BOOT button on ESP32-C6 and ESP32-H2).
 
 #### Using Arduino IDE

libraries/Zigbee/examples/Zigbee_Light_Sensor/Zigbee_Light_Sensor.ino renamed to libraries/Zigbee/examples/Zigbee_Light_Sensor/Zigbee_Illuminance_Sensor.ino

@@ -13,10 +13,10 @@
 // limitations under the License.
 
 /**
- * @brief This example demonstrates Zigbee light sensor.
+ * @brief This example demonstrates Zigbee illuminance sensor.
  *
- * The example demonstrates how to use Zigbee library to create a end device light sensor.
- * The light sensor is a Zigbee end device, which is controlled by a Zigbee coordinator.
+ * The example demonstrates how to use Zigbee library to create a end device illuminance sensor.
+ * The illuminance sensor is a Zigbee end device, which is controlled by a Zigbee coordinator.
  *
  * Proper Zigbee mode must be selected in Tools->Zigbee mode
  * and also the correct partition scheme must be selected in Tools->Partition Scheme.
@@ -32,31 +32,31 @@
 
  #include "Zigbee.h"
 
- #define ZIGBEE_LIGHT_SENSOR_ENDPOINT 9
+ #define ZIGBEE_ILLUMINANCE_SENSOR_ENDPOINT 9
  uint8_t button = BOOT_PIN;
- uint8_t light_sensor_pin = 6; // Insert the analog pin to which the sensor (e.g. photoresistor) is connected
+ uint8_t illuminance_sensor_pin = 6; // Insert the analog pin to which the sensor (e.g. photoresistor) is connected
 
- ZigbeeLightSensor zbLightSensor = ZigbeeLightSensor(ZIGBEE_LIGHT_SENSOR_ENDPOINT);
+ ZigbeeIlluminanceSensor zbIlluminanceSensor = ZigbeeIlluminanceSensor(ZIGBEE_ILLUMINANCE_SENSOR_ENDPOINT);
 
- /********************* Light sensor **************************/
- static void light_sensor_value_update(void *arg) {
+ /********************* Illuminance sensor **************************/
+ static void illuminance_sensor_value_update(void *arg) {
    for (;;) {
      // read the raw analog value from the sensor
-     int lsens_analog_raw = analogRead(light_sensor_pin);
-     Serial.printf("[Light Sensor] raw analog value: %d\r\n", lsens_analog_raw);
+     int lsens_analog_raw = analogRead(illuminance_sensor_pin);
+     Serial.printf("[Illuminance Sensor] raw analog value: %d\r\n", lsens_analog_raw);
 
      // conversion into zigbee raw illuminance value (typically between 0 in darkness and 50000 in direct sunlight)
      // depends on the value range of the raw analog sensor values and will need calibration for correct lux values
      int lsens_illuminance_raw = lsens_analog_raw * 10; // multiply by 10 for the sake of this example
-     Serial.printf("[Light Sensor] raw illuminance value: %d\r\n", lsens_illuminance_raw);
+     Serial.printf("[Illuminance Sensor] raw illuminance value: %d\r\n", lsens_illuminance_raw);
 
      // according to zigbee documentation the formular 10^(lsens_illuminance_raw/10000)-1 can be used to calculate lux value from raw illuminance value
      // Note: Zigbee2MQTT seems to be using the formular 10^(lsens_illuminance_raw/10000) instead (without -1)
      int lsens_illuminance_lux = round(pow(10,(lsens_illuminance_raw / 10000.0))-1);
-     Serial.printf("[Light Sensor] lux value: %d lux\r\n", lsens_illuminance_lux);
+     Serial.printf("[Illuminance Sensor] lux value: %d lux\r\n", lsens_illuminance_lux);
 
-     // Update illuminance in light sensor EP
-     zbLightSensor.setIlluminance(lsens_illuminance_raw); // use raw illuminance here!
+     // Update illuminance in illuminance sensor EP
+     zbIlluminanceSensor.setIlluminance(lsens_illuminance_raw); // use raw illuminance here!
 
      delay(1000); // reduce delay (in ms), if you want your device to react more quickly to changes in illuminance
    }
@@ -74,20 +74,20 @@
    pinMode(button, INPUT_PULLUP);
 
    // Optional: Set Zigbee device name and model
-   zbLightSensor.setManufacturerAndModel("Espressif", "ZigbeeLightSensor");
+   zbIlluminanceSensor.setManufacturerAndModel("Espressif", "ZigbeeIlluminanceSensor");
 
    // Optional: Set power source (choose between ZB_POWER_SOURCE_MAINS and ZB_POWER_SOURCE_BATTERY), defaults to unknown
-   zbLightSensor.setPowerSource(ZB_POWER_SOURCE_MAINS);
+   zbIlluminanceSensor.setPowerSource(ZB_POWER_SOURCE_MAINS);
 
    // Set minimum and maximum for raw illuminance value (0 min and 50000 max equals to 0 lux - 100,000 lux)
-   zbLightSensor.setMinMaxValue(0, 50000);
+   zbIlluminanceSensor.setMinMaxValue(0, 50000);
 
    // Optional: Set tolerance for raw illuminance value
-   zbLightSensor.setTolerance(1);
+   zbIlluminanceSensor.setTolerance(1);
 
    // Add endpoint to Zigbee Core
-   Serial.println("Adding Zigbee light sensor endpoint to Zigbee Core");
-   Zigbee.addEndpoint(&zbLightSensor);
+   Serial.println("Adding Zigbee illuminance sensor endpoint to Zigbee Core");
+   Zigbee.addEndpoint(&zbIlluminanceSensor);
 
    Serial.println("Starting Zigbee...");
    // When all EPs are registered, start Zigbee in End Device mode
@@ -105,16 +105,16 @@
    }
    Serial.println();
 
-   // Start light sensor reading task
-   xTaskCreate(light_sensor_value_update, "light_sensor_update", 2048, NULL, 10, NULL);
+   // Start illuminance sensor reading task
+   xTaskCreate(illuminance_sensor_value_update, "illuminance_sensor_update", 2048, NULL, 10, NULL);
 
    // Set reporting schedule for illuminance value measurement in seconds, must be called after Zigbee.begin()
    // min_interval and max_interval in seconds, delta
    // if min = 1 and max = 0, delta = 1000, reporting is sent when raw illuminance value changes by 1000, but at most once per second
    // if min = 0 and max = 10, delta = 1000, reporting is sent every 10 seconds or if raw illuminance value changes by 1000
    // if min = 0, max = 10 and delta = 0, reporting is sent every 10 seconds regardless of illuminance change
    // Note: On pairing with Zigbee Home Automation or Zigbee2MQTT the reporting schedule will most likely be overwritten with their default settings 
-   zbLightSensor.setReporting(1, 0, 1000);
+   zbIlluminanceSensor.setReporting(1, 0, 1000);
  }
 
  /********************* Main loop **************************/
@@ -134,7 +134,7 @@
        }
      }
      // force report of illuminance when button is pressed
-     zbLightSensor.reportIlluminance();
+     zbIlluminanceSensor.reportIlluminance();
    }
    delay(100);
  }

libraries/Zigbee/keywords.txt

@@ -29,7 +29,7 @@ ZigbeeGateway	KEYWORD1
 ZigbeeRangeExtender	KEYWORD1
 ZigbeeVibrationSensor	KEYWORD1
 ZigbeeWindowCovering	KEYWORD1
-ZigbeeLightSensor	KEYWORD1
+ZigbeeIlluminanceSensor	KEYWORD1
 
 # Other
 zigbee_role_t	KEYWORD1
@@ -125,8 +125,8 @@ setHumidityReporting	KEYWORD2
 reportHumidity	KEYWORD2
 
 # ZigbeeLightSensor
-setLightValue	KEYWORD2
-reportLightValue	KEYWORD2
+setIlluminance	KEYWORD2
+reportIlluminance	KEYWORD2
 
 # ZigbeeFlowSensor
 setFlow	KEYWORD2

libraries/Zigbee/src/Zigbee.h

@@ -18,7 +18,7 @@
 #include "ep/ZigbeeAnalog.h"
 #include "ep/ZigbeeFlowSensor.h"
 #include "ep/ZigbeeOccupancySensor.h"
-#include "ep/ZigbeeLightSensor.h"
+#include "ep/ZigbeeIlluminanceSensor.h"
 #include "ep/ZigbeeCarbonDioxideSensor.h"
 #include "ep/ZigbeeContactSwitch.h"
 #include "ep/ZigbeeDoorWindowHandle.h"

libraries/Zigbee/src/ep/ZigbeeLightSensor.cpp renamed to libraries/Zigbee/src/ep/ZigbeeIlluminanceSensor.cpp

@@ -1,7 +1,7 @@
-#include "ZigbeeLightSensor.h"
+#include "ZigbeeIlluminanceSensor.h"
 #if CONFIG_ZB_ENABLED
 
-ZigbeeLightSensor::ZigbeeLightSensor(uint8_t endpoint) : ZigbeeEP(endpoint) {
+ZigbeeIlluminanceSensor::ZigbeeIlluminanceSensor(uint8_t endpoint) : ZigbeeEP(endpoint) {
   _device_id = ESP_ZB_HA_LIGHT_SENSOR_DEVICE_ID;
 
   esp_zb_light_sensor_cfg_t light_sensor_cfg = ESP_ZB_DEFAULT_LIGHT_SENSOR_CONFIG();
@@ -16,7 +16,7 @@ static int16_t zb_int_to_s16(int value) {
   return (int16_t) value;
 }
 
-void ZigbeeLightSensor::setMinMaxValue(int min, int max) {
+void ZigbeeIlluminanceSensor::setMinMaxValue(int min, int max) {
   int16_t zb_min = zb_int_to_s16(min);
   int16_t zb_max = zb_int_to_s16(max);
   esp_zb_attribute_list_t *light_measure_cluster =
@@ -25,14 +25,14 @@ void ZigbeeLightSensor::setMinMaxValue(int min, int max) {
   esp_zb_cluster_update_attr(light_measure_cluster, ESP_ZB_ZCL_ATTR_ILLUMINANCE_MEASUREMENT_MAX_MEASURED_VALUE_ID, (void *)&zb_max);
 }
 
-void ZigbeeLightSensor::setTolerance(int tolerance) {
+void ZigbeeIlluminanceSensor::setTolerance(int tolerance) {
   uint16_t zb_tolerance = (uint16_t) tolerance;
   esp_zb_attribute_list_t *light_measure_cluster =
     esp_zb_cluster_list_get_cluster(_cluster_list, ESP_ZB_ZCL_CLUSTER_ID_ILLUMINANCE_MEASUREMENT, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
     esp_zb_illuminance_meas_cluster_add_attr(light_measure_cluster, ESP_ZB_ZCL_ATTR_ILLUMINANCE_MEASUREMENT_TOLERANCE_ID, (void *)&zb_tolerance);
 }
 
-void ZigbeeLightSensor::setReporting(uint16_t min_interval, uint16_t max_interval, int delta) {
+void ZigbeeIlluminanceSensor::setReporting(uint16_t min_interval, uint16_t max_interval, int delta) {
   esp_zb_zcl_reporting_info_t reporting_info;
   memset(&reporting_info, 0, sizeof(esp_zb_zcl_reporting_info_t));
   reporting_info.direction = ESP_ZB_ZCL_CMD_DIRECTION_TO_SRV;
@@ -52,10 +52,10 @@ void ZigbeeLightSensor::setReporting(uint16_t min_interval, uint16_t max_interva
   esp_zb_lock_release();
 }
 
-void ZigbeeLightSensor::setIlluminance(int illuminanceValue) {
+void ZigbeeIlluminanceSensor::setIlluminance(int illuminanceValue) {
   int16_t zb_illuminanceValue = zb_int_to_s16(illuminanceValue);
   log_v("Updating Illuminance...");
-  /* Update light sensor measured illuminance */
+  /* Update illuminance sensor measured illuminance */
   log_d("Setting Illuminance to %d", zb_illuminanceValue);
   esp_zb_lock_acquire(portMAX_DELAY);
   esp_zb_zcl_set_attribute_val(
@@ -64,7 +64,7 @@ void ZigbeeLightSensor::setIlluminance(int illuminanceValue) {
   esp_zb_lock_release();
 }
 
-void ZigbeeLightSensor::reportIlluminance() {
+void ZigbeeIlluminanceSensor::reportIlluminance() {
   /* Send report attributes command */
   esp_zb_zcl_report_attr_cmd_t report_attr_cmd;
   report_attr_cmd.address_mode = ESP_ZB_APS_ADDR_MODE_DST_ADDR_ENDP_NOT_PRESENT;

libraries/Zigbee/src/ep/ZigbeeLightSensor.h renamed to libraries/Zigbee/src/ep/ZigbeeIlluminanceSensor.h

@@ -1,4 +1,4 @@
-/* Class of Zigbee Light sensor endpoint inherited from common EP class */
+/* Class of Zigbee Illuminance sensor endpoint inherited from common EP class */
 
 #pragma once
 
@@ -13,7 +13,7 @@
 the new macro works here, but should better be added to
 esp-zigbee-sdk/components/esp-zigbee-lib/include/ha/esp_zigbee_ha_standard.h
 */
-#define ESP_ZB_DEFAULT_LIGHT_SENSOR_CONFIG()                                                            \
+#define ESP_ZB_DEFAULT_LIGHT_SENSOR_CONFIG()                                                      \
     {                                                                                                   \
         .basic_cfg =                                                                                    \
             {                                                                                           \
@@ -36,24 +36,24 @@ esp-zigbee-sdk/components/esp-zigbee-lib/include/ha/esp_zigbee_ha_standard.h
             },                                                                                          \
     }
 
-class ZigbeeLightSensor : public ZigbeeEP {
+class ZigbeeIlluminanceSensor : public ZigbeeEP {
 public:
-  ZigbeeLightSensor(uint8_t endpoint);
-  ~ZigbeeLightSensor() {}
+  ZigbeeIlluminanceSensor(uint8_t endpoint);
+  ~ZigbeeIlluminanceSensor() {}
 
-  // Set the light value
+  // Set the illuminance value
   void setIlluminance(int value);
 
-  // Set the min and max value for the light sensor
+  // Set the min and max value for the illuminance sensor
   void setMinMaxValue(int min, int max);
 
-  // Set the tolerance value for the light sensor
+  // Set the tolerance value for the illuminance sensor
   void setTolerance(int tolerance);
 
-  // Set the reporting interval for light measurement in seconds and delta
+  // Set the reporting interval for illuminance measurement in seconds and delta
   void setReporting(uint16_t min_interval, uint16_t max_interval, int delta);
 
-  // Report the light value
+  // Report the illuminance value
   void reportIlluminance();
 };