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.

99 lines
3.0 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. typedef std::function<void(unsigned char, const char *)> TSensorCallback;
  18. class BaseSensor {
  19. public:
  20. // Constructor
  21. BaseSensor() {}
  22. // Destructor
  23. ~BaseSensor() {}
  24. // Initialization method, must be idempotent
  25. virtual void begin() {}
  26. // Loop-like method, call it in your main loop
  27. virtual void tick() {}
  28. // Pre-read hook (usually to populate registers with up-to-date data)
  29. virtual void pre() {}
  30. // Post-read hook (usually to reset things)
  31. virtual void post() {}
  32. // Descriptive name of the sensor
  33. virtual String description() {}
  34. // Address of the sensor (it could be the GPIO or I2C address)
  35. virtual String address(unsigned char index) {}
  36. // Descriptive name of the slot # index
  37. virtual String slot(unsigned char index) {};
  38. // Type for slot # index
  39. virtual unsigned char type(unsigned char index) {}
  40. // Current value for slot # index
  41. virtual double value(unsigned char index) {}
  42. // Retrieve current instance configuration
  43. virtual void getConfig(JsonObject& root) {};
  44. // Save current instance configuration
  45. virtual void setConfig(JsonObject& root) {};
  46. // Load the configuration manifest
  47. static void manifest(JsonArray& root) {};
  48. // Sensor ID
  49. unsigned char getID() { return _sensor_id; };
  50. // Return status (true if no errors)
  51. bool status() { return 0 == _error; }
  52. // Return ready status (true for ready)
  53. bool ready() { return _ready; }
  54. // Return sensor last internal error
  55. int error() { return _error; }
  56. // Number of available slots
  57. unsigned char count() { return _count; }
  58. // Hook for event callback
  59. void onEvent(TSensorCallback fn) { _callback = fn; };
  60. protected:
  61. TSensorCallback _callback = NULL;
  62. unsigned char _sensor_id = 0x00;
  63. int _error = 0;
  64. bool _dirty = true;
  65. unsigned char _count = 0;
  66. bool _ready = false;
  67. };
  68. #endif