Sensors.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. #ifndef UNITEMP_SENSORS
  2. #define UNITEMP_SENSORS
  3. #include <furi.h>
  4. #include <input/input.h>
  5. //Маски бит для определения типов возвращаемых значений
  6. #define UT_TEMPERATURE 0b00000001
  7. #define UT_HUMIDITY 0b00000010
  8. #define UT_PRESSURE 0b00000100
  9. //Статусы опроса датчика
  10. typedef enum {
  11. UT_DATA_TYPE_TEMP = UT_TEMPERATURE,
  12. UT_DATA_TYPE_TEMP_HUM = UT_TEMPERATURE | UT_HUMIDITY,
  13. UT_DATA_TYPE_TEMP_PRESS = UT_TEMPERATURE | UT_PRESSURE,
  14. UT_DATA_TYPE_TEMP_HUM_PRESS = UT_TEMPERATURE | UT_HUMIDITY | UT_PRESSURE,
  15. } SensorDataType;
  16. //Типы возвращаемых данных
  17. typedef enum {
  18. UT_OK, //Всё хорошо, опрос успешен
  19. UT_TIMEOUT, //Датчик не отозвался
  20. UT_EARLYPOOL, //Опрос раньше положенной задержки
  21. UT_BADCRC, //Неверная контрольная сумма
  22. UT_ERROR, //Прочие ошибки
  23. UT_POLLING, //В датчике происходит преобразование
  24. UT_INACTIVE, //Датчик на редактировании или удалён
  25. } UnitempStatus;
  26. //Порт ввода/вывода Flipper Zero
  27. typedef struct GPIO {
  28. const uint8_t num;
  29. const char* name;
  30. const GpioPin* pin;
  31. } GPIO;
  32. typedef struct Sensor Sensor;
  33. /**
  34. * @brief Указатель функции выделения памяти и подготовки экземпляра датчика
  35. */
  36. typedef bool(SensorAllocator)(Sensor* sensor, char* args);
  37. /**
  38. * @brief Указатель на функцию высвобождении памяти датчика
  39. */
  40. typedef bool(SensorFree)(Sensor* sensor);
  41. /**
  42. * @brief Указатель функции инициализации датчика
  43. */
  44. typedef bool(SensorInitializer)(Sensor* sensor);
  45. /**
  46. * @brief Указатель функции деинициализации датчика
  47. */
  48. typedef bool(SensorDeinitializer)(Sensor* sensor);
  49. /**
  50. * @brief Указатель функции обновления значения датчика
  51. */
  52. typedef UnitempStatus(SensorUpdater)(Sensor* sensor);
  53. //Типы подключения датчиков
  54. typedef struct Interface {
  55. //Имя интерфейса
  56. const char* name;
  57. //Функция выделения памяти интерфейса
  58. SensorAllocator* allocator;
  59. //Функция высвыбождения памяти интерфейса
  60. SensorFree* mem_releaser;
  61. //Функция обновления значения датчика по интерфейсу
  62. SensorUpdater* updater;
  63. } Interface;
  64. //Типы датчиков
  65. typedef struct {
  66. //Имя типа датчика
  67. const char* typename;
  68. //Тип возвращаемых данных
  69. SensorDataType datatype;
  70. //Интерфейс подключения
  71. const Interface* interface;
  72. //Интервал опроса датчика
  73. uint16_t pollingInterval;
  74. //Функция выделения памяти для датчика
  75. SensorAllocator* allocator;
  76. //Функция высвыбождения памяти для датчика
  77. SensorFree* mem_releaser;
  78. //Функция инициализации датчика
  79. SensorInitializer* initializer;
  80. //Функция деинициализация датчика
  81. SensorDeinitializer* deinitializer;
  82. //Функция обновления значения датчка
  83. SensorUpdater* updater;
  84. } SensorType;
  85. //Датчик
  86. typedef struct Sensor {
  87. //Имя датчика
  88. char* name;
  89. //Температура
  90. float temp;
  91. //Относительная влажность
  92. float hum;
  93. //Атмосферное давление
  94. float pressure;
  95. //Тип датчика
  96. const SensorType* type;
  97. //Статус последнего опроса датчика
  98. UnitempStatus status;
  99. //Время последнего опроса датчика
  100. uint32_t lastPollingTime;
  101. //Экземпляр датчика
  102. void* instance;
  103. } Sensor;
  104. extern const Interface SINGLE_WIRE; //Собственный однопроводной протокол датчиков DHTXX и AM23XX
  105. extern const Interface ONE_WIRE; //Однопроводной протокол Dallas
  106. extern const Interface I2C; //I2C_2 (PC0, PC1)
  107. //extern const Interface SPI;
  108. /* ============================= Датчик(и) ============================= */
  109. /**
  110. * @brief Выделение памяти под датчик
  111. *
  112. * @param name Имя датчика
  113. * @param type Тип датчика
  114. * @param args Указатель на строку с парамерами датчика
  115. * @return Указатель на датчик в случае успешного выделения памяти, NULL при ошибке
  116. */
  117. Sensor* unitemp_sensor_alloc(char* name, const SensorType* type, char* args);
  118. /**
  119. * @brief Высвыбождение памяти конкретного датчка
  120. * @param sensor Указатель на датчик
  121. */
  122. void unitemp_sensor_free(Sensor* sensor);
  123. /**
  124. * @brief Обновление данных указанного датчика
  125. * @param sensor Указатель на датчик
  126. * @return Статус опроса датчика
  127. */
  128. UnitempStatus unitemp_sensor_updateData(Sensor* sensor);
  129. /**
  130. * @brief Проверка наличия датчика в памяти
  131. *
  132. * @param sensor Указатель на датчик
  133. * @return Истина если этот датчик уже загружен, ложь если это новый датчик
  134. */
  135. bool unitemp_sensor_isContains(Sensor* sensor);
  136. /**
  137. * @brief Получить датчик из списка по индексу
  138. *
  139. * @param index Индекс датчика (0 - unitemp_sensors_getCount())
  140. * @return Указатель на датчик при успехе, NULL при неудаче
  141. */
  142. Sensor* unitemp_sensor_getActive(uint8_t index);
  143. /**
  144. * @brief Загрузка датчиков с SD-карты
  145. * @return Истина если загрузка прошла успешно
  146. */
  147. bool unitemp_sensors_load();
  148. /**
  149. * @brief Функция перезагрузки датчиков с SD-карты
  150. */
  151. void unitemp_sensors_reload(void);
  152. /**
  153. * @brief Сохранение датчиков на SD-карту
  154. * @return Истина если сохранение прошло успешно
  155. */
  156. bool unitemp_sensors_save(void);
  157. /**
  158. * @brief Удаление датчика
  159. *
  160. * @param sensor Указатель на датчик
  161. */
  162. void unitemp_sensor_delete(Sensor* sensor);
  163. /**
  164. * @brief Инициализация загруженных датчиков
  165. * @return Истина если всё прошло успешно
  166. */
  167. bool unitemp_sensors_init(void);
  168. /**
  169. * @brief Деинициализация загруженных датчиков
  170. * @return Истина если всё прошло успешно
  171. */
  172. bool unitemp_sensors_deInit(void);
  173. /**
  174. * @brief Высвыбождение памяти всех датчиков
  175. */
  176. void unitemp_sensors_free(void);
  177. /**
  178. * @brief Обновить данные всех датчиков
  179. */
  180. void unitemp_sensors_updateValues(void);
  181. /**
  182. * @brief Получить количество загруженных датчиков
  183. * @return Количество датчиков
  184. */
  185. uint8_t unitemp_sensors_getCount(void);
  186. /**
  187. * @brief Добавить датчик в общий список
  188. * @param sensor Указатель на датчик
  189. */
  190. void unitemp_sensors_add(Sensor* sensor);
  191. /**
  192. * @brief Получить списк доступных типов датчиков
  193. * @return Указатель на список датчиков
  194. */
  195. const SensorType** unitemp_sensors_getTypes(void);
  196. /**
  197. * @brief Получить количество доступных типов датчиков
  198. * @return Количество доступных типов датчиков
  199. */
  200. uint8_t unitemp_sensors_getTypesCount(void);
  201. /**
  202. * @brief Получить тип сенсора по его индексу
  203. * @param index Индекс типа датчика (от 0 до SENSOR_TYPES_COUNT)
  204. * @return const SensorType*
  205. */
  206. const SensorType* unitemp_sensors_getTypeFromInt(uint8_t index);
  207. /**
  208. * @brief Преобразовать строчное название датчка в указатель
  209. *
  210. * @param str Имя датчика в виде строки
  211. * @return Указатель на тип датчика при успехе, иначе NULL
  212. */
  213. const SensorType* unitemp_sensors_getTypeFromStr(char* str);
  214. /**
  215. * @brief Получить количество активных датчиков
  216. *
  217. * @return Количество активных датчиков
  218. */
  219. uint8_t unitemp_sensors_getActiveCount(void);
  220. /* ============================= GPIO ============================= */
  221. /**
  222. * @brief Конвертация номера порта на корпусе FZ в GPIO
  223. * @param name Номер порта на корпусе FZ
  224. * @return Указатель на GPIO при успехе, NULL при ошибке
  225. */
  226. const GPIO* unitemp_gpio_getFromInt(uint8_t name);
  227. /**
  228. * @brief Конвертация GPIO в номер на корпусе FZ
  229. * @param gpio Указатель на порт
  230. * @return Номер порта на корпусе FZ
  231. */
  232. uint8_t unitemp_gpio_toInt(const GPIO* gpio);
  233. /**
  234. * @brief Блокировка GPIO указанным интерфейсом
  235. * @param gpio Указатель на порт
  236. * @param interface Указатель на интерфейс, которым порт будет занят
  237. */
  238. void unitemp_gpio_lock(const GPIO* gpio, const Interface* interface);
  239. /**
  240. * @brief Разблокировка порта
  241. * @param gpio Указатель на порт
  242. */
  243. void unitemp_gpio_unlock(const GPIO* gpio);
  244. /**
  245. * @brief Получить количество доступных портов для указанного интерфейса
  246. * @param interface Указатель на интерфейс
  247. * @return Количество доступных портов
  248. */
  249. uint8_t unitemp_gpio_getAviablePortsCount(const Interface* interface, const GPIO* extraport);
  250. /**
  251. * @brief Получить указатель на доступный для интерфейса порт по индексу
  252. * @param interface Указатель на интерфейс
  253. * @param index Номер порта (от 0 до unitemp_gpio_getAviablePortsCount())
  254. * @param extraport Указатель на дополнительный порт, который будет принудительно считаться доступным. Можно указать NULL если не требуется
  255. * @return Указатель на доступный порт
  256. */
  257. const GPIO*
  258. unitemp_gpio_getAviablePort(const Interface* interface, uint8_t index, const GPIO* extraport);
  259. /* Датчики */
  260. //DHTxx и их производные
  261. #include "./interfaces/SingleWireSensor.h"
  262. //DS18x2x
  263. #include "./interfaces/OneWireSensor.h"
  264. #include "./sensors/LM75.h"
  265. #include "./sensors/BMP280.h"
  266. #endif