Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

101 lines
3.2 KiB

  1. // -----------------------------------------------------------------------------
  2. // Abstract sensor class (other sensor classes extend this class)
  3. // Copyright (C) 2017-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. // -----------------------------------------------------------------------------
  5. #if SENSOR_SUPPORT
  6. #pragma once
  7. #include <Arduino.h>
  8. #include <ArduinoJson.h>
  9. #define SENSOR_ERROR_OK 0 // No error
  10. #define SENSOR_ERROR_OUT_OF_RANGE 1 // Result out of sensor range
  11. #define SENSOR_ERROR_WARM_UP 2 // Sensor is warming-up
  12. #define SENSOR_ERROR_TIMEOUT 3 // Response from sensor timed out
  13. #define SENSOR_ERROR_UNKNOWN_ID 4 // Sensor did not report a known ID
  14. #define SENSOR_ERROR_CRC 5 // Sensor data corrupted
  15. #define SENSOR_ERROR_I2C 6 // Wrong or locked I2C address
  16. #define SENSOR_ERROR_GPIO_USED 7 // The GPIO is already in use
  17. #define SENSOR_ERROR_CALIBRATION 8 // Calibration error or Not calibrated
  18. #define SENSOR_ERROR_OTHER 99 // Any other error
  19. typedef std::function<void(unsigned char, const char *)> TSensorCallback;
  20. class BaseSensor {
  21. public:
  22. // Constructor
  23. BaseSensor() {}
  24. // Destructor
  25. ~BaseSensor() {}
  26. // Initialization method, must be idempotent
  27. virtual void begin() {}
  28. // Loop-like method, call it in your main loop
  29. virtual void tick() {}
  30. // Pre-read hook (usually to populate registers with up-to-date data)
  31. virtual void pre() {}
  32. // Post-read hook (usually to reset things)
  33. virtual void post() {}
  34. // Descriptive name of the sensor
  35. virtual String description() = 0;
  36. // Address of the sensor (it could be the GPIO or I2C address)
  37. virtual String address(unsigned char index) = 0;
  38. // Descriptive name of the slot # index
  39. virtual String slot(unsigned char index) = 0;
  40. // Type for slot # index
  41. virtual unsigned char type(unsigned char index) = 0;
  42. // Current value for slot # index
  43. virtual double value(unsigned char index) = 0;
  44. // Retrieve current instance configuration
  45. virtual void getConfig(JsonObject& root) {};
  46. // Save current instance configuration
  47. virtual void setConfig(JsonObject& root) {};
  48. // Load the configuration manifest
  49. static void manifest(JsonArray& root) {};
  50. // Sensor ID
  51. unsigned char getID() { return _sensor_id; };
  52. // Return status (true if no errors)
  53. bool status() { return 0 == _error; }
  54. // Return ready status (true for ready)
  55. bool ready() { return _ready; }
  56. // Return sensor last internal error
  57. int error() { return _error; }
  58. // Number of available slots
  59. unsigned char count() { return _count; }
  60. // Hook for event callback
  61. void onEvent(TSensorCallback fn) { _callback = fn; };
  62. protected:
  63. TSensorCallback _callback = NULL;
  64. unsigned char _sensor_id = 0x00;
  65. int _error = 0;
  66. bool _dirty = true;
  67. unsigned char _count = 0;
  68. bool _ready = false;
  69. };
  70. #endif