ESP32 の ULP を活用したワイヤレス雨量計の作り方を紹介します．
はじめに
下のような本格的な機材が安く手にはいったので，これに ESP32 を接続して Fluentd に計測結果を送り，Grafana でモニタリングできるようにします．
回路設計
今回使用する雨量計は，転倒ます型といって 0.5mm の雨が溜まる度に信号ラインが 0.1～0.2秒間ショートするようになっています．構造としては，鹿威しをベースにして磁石によってON/OFFするリードスイッチを組み合わせた作りです．
回路としては，端子の片方を 3.3V，他方を 10kΩ を介して GND に接続し，雨が溜まる度に一瞬 H を出力するようにしておきき，ESP32 の GPIO に接続します．
ちなみに，最初はこの逆，すなわち雨が溜まる度に一瞬 L になるような回路にしていたのですが，Wifi 接続時の電圧降下での誤カウント等が発生したので，前述の構成に変更しました．
乾電池から 3.3V を生成する電源と組み合わせて仕立てるとこんな感じ．
ソフト設計
ESP32 のソフトは，端子のレベルを監視し，L→H になった回数のカウントを行います．
消費電力を抑えたいので，定期的に ULP を動作させて端子の電圧レベルを監視することにしました．ULP は消費電力が少ないといっても 150uA 程度消費してしまうのに対し，Deep Sleep 状態では 5uA 程度なので，ULP を間欠動作させると電池のもちが全然違ってきています．
雨量計の最小パルス幅は 0.1秒なので，余裕をみてULP は 30ms 毎に動作させることにします．
ソフト実装
コード全体は github にあげてあります．
ULP 側
ULP は動作する度に雨量計の出力をモニタし，L → H のエッジのカウントを行います．センサのチャタリング除去のため，次のようなステートマシンを組むことにします．
コード全体は下記のような感じです．上の図と照らしながら見てもらえば，やっていることは分かるかと思います．
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
#include "soc/rtc_cntl_reg.h" #include "soc/rtc_io_reg.h" #include "soc/soc_ulp.h" #include "util_macro.S" .set LOW_HYST_BIT,3 .set SENSE_BUF_SIZE,512 .bss .global gpio_num gpio_num: .long 0 // 0: previous state is low // 1: previous state is low check low level continuity // 2: previous state high .global watch_state watch_state: .long 0 .global gpio_level gpio_level: .long 0 .global edge_count edge_count: .long 0 .global continue_count continue_count: .long 0 .global predecessing_zero predecessing_zero: .long 0 .global sense_count sense_count: .long 0 .balign 4 .global sense_data sense_data: .long 0 .skip SENSE_BUF_SIZE stack: .skip 32 .global stackEnd stackEnd: .long 0 .text .global entry entry: move r3,stackEnd loop: psr jump watch halt watch: READ_RTC_FIELD(RTC_GPIO_IN_REG, RTC_GPIO_IN_NEXT) move r1, gpio_num ld r1, r1, 0 rsh r0, r0, r1 and r0, r0, 1 move r1, gpio_level st r0, r1, 0 push r0 move r1, watch_state ld r2, r1, 0 and r0, r2, 1 // state == 1 jumpr watch_state_1, 1, ge rsh r2, r2, 1 and r0, r2, 1 // state == 2 jumpr watch_state_2, 1, ge jump watch_state_0 watch_end: ret //////////////////////////////////////////////////////////// // previous state is low watch_state_0: pop r0 // gpio level jumpr _state_0_to_2, 1, ge ret _state_0_to_2: // up edge detected // increase edge count move r1, edge_count ld r2, r1, 0 add r2, r2, 1 st r2, r1, 0 // change state move r1, watch_state move r2, 2 st r2, r1, 0 ret //////////////////////////////////////////////////////////// // previous state is low and check low state continuity watch_state_1: pop r0 // gpio level jumpr _state_1_to_2, 1, ge // increase high continuity count move r1, continue_count ld r2, r1, 0 add r2, r2, 1 st r2, r1, 0 rsh r0, r2, LOW_HYST_BIT jumpr _state_1_to_0, 1, ge jump watch_end _state_1_to_0: // change state move r1, watch_state move r2, 0 st r2, r1, 0 jump watch_end _state_1_to_2: // reset high continuity count move r1, continue_count move r2, 2 st r2, r1, 0 jump watch_end //////////////////////////////////////////////////////////// // previous state low watch_state_2: pop r0 // gpio level jumpr _state_2_to_1, 1, lt jump watch_end _state_2_to_1: // reset high continuity count move r1, continue_count move r2, 0 st r2, r1, 0 // change state move r1, watch_state move r2, 1 st r2, r1, 1 jump watch_end wake_cpu: wake // stop wake up timer WRITE_RTC_FIELD(RTC_CNTL_STATE0_REG, RTC_CNTL_ULP_CP_SLP_TIMER_EN, 0) exit: halt // Local Variables: // mode: asm // comment-start: "// " // End: |
CPU 側
CPU は 1分ごとに起きて，ULP がカウントした値を取得します．そして，必要に応じて WiFi を有効化し，値を Fluentd に送信します．
コード全体は下記のようになっています．Fluentd への送信コードがあるのでやや長くなっていますが，やっていることは目を通していただければ分かると思います．
以下の点を工夫しています．
- 雨の降り始めはすぐに通知
- WiFi 通信頻度と電池の持ちはトレードオフの関係にありますが，雨の降り始めはなるべく早く知りたいので，降り始めを検出した場合はすぐに WiFi 通信を行うようにしました．雨が降っていない場合は通信回数は1時間に1回です．
- エラー時にリセットしない
- これまで，ESP32 を使って屋外のセンシングをしていると，時々データの歯抜けが生じていました．原因としては何らかのエラーでデバイスがリセットしていることが推測されます．そこで，エラーチェックについては，エラー時にリセットを行ってしまう ESP_ERROR_CHECK を使わず，独自に ERROR_RETURN というマクロを定義して使っています．
- Fluentd への送信リトライ
- WiFi 接続を含め，Fluentd への送信時にエラーが起こった場合，データは保持して次回の送信タイミングに再送をこころみるようにしてあります．前項とセットで適用することで，データの歯抜けがなくなりました．
- 電波強度やリトライ回数の送信
- 実際に運用する場合，エラーの兆候がつかめる仕組みがないと安定稼働させるのが困難です．そこで，WiFi 接続にかかった時間，電波強度(RSSI)，リトライ回数等を Fluentd に送るようにしてあります．
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
#include "nvs_flash.h" #include "soc/rtc.h" #include "soc/sens_reg.h" #include "driver/gpio.h" #include "driver/rtc_io.h" #include "driver/adc.h" #include "lwip/sockets.h" #include "esp32/ulp.h" #define LOG_LOCAL_LEVEL ESP_LOG_INFO #include "esp_log.h" #include "esp_adc_cal.h" #include "esp_event_loop.h" #include "esp_sleep.h" #include "esp_spi_flash.h" #include "esp_task_wdt.h" #include "esp_wifi.h" #include <stdlib.h> #include <stdbool.h> #include <string.h> #include "cJSON.h" #include "ulp_main.h" #include "wifi_config.h" // wifi_config.h should define followings. // #define WIFI_SSID "XXXXXXXX" // WiFi SSID // #define WIFI_PASS "XXXXXXXX" // WiFi Password /* #define ADC_CALIB_MODE */ //////////////////////////////////////////////////////////// // Configuration #define FLUENTD_IP "192.168.2.20" // IP address of Fluentd #define FLUENTD_PORT 8888 // Port of FLuentd #define FLUENTD_TAG "/sensor" // Fluentd tag #define WIFI_HOSTNAME "ESP32-rain" // module's hostname #define SENSE_INTERVAL 60 // sensing interval #define SENSE_BUF_COUNT 5 // buffering count #define SENSE_BUF_FULL 30 // full buffering count #define SENSE_BUF_MAX 60 // max buffering count #define ADC_VREF 1100 // ADC calibration data //////////////////////////////////////////////////////////// const gpio_num_t GAUGE_PIN = GPIO_NUM_25; const uint16_t GAUGE_PIN_ULP= 6; #define BATTERY_ADC_CH ADC1_CHANNEL_5 // GPIO 33 #define BATTERY_ADC_SAMPLE 33 #define BATTERY_ADC_DIV 1 //////////////////////////////////////////////////////////// #define WIFI_CONNECT_TIMEOUT 3 typedef struct sense_data { uint16_t rainfall; } sense_data_t; extern const uint8_t ulp_main_bin_start[] asm("_binary_ulp_main_bin_start"); extern const uint8_t ulp_main_bin_end[] asm("_binary_ulp_main_bin_end"); #define TAG "ulp_rain_gauge" #define EXPECTED_RESPONSE "HTTP/1.1 200 OK" #define REQUEST "POST http://" FLUENTD_IP FLUENTD_TAG " HTTP/1.0\r\n" \ "Content-Type: application/x-www-form-urlencoded\r\n" \ "Content-Length: %d\r\n" \ "\r\n" \ "json=%s" SemaphoreHandle_t wifi_conn_done = NULL; ////////////////////////////////////////////////////////////////////// // Error Handling static void _error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression) { ets_printf("ESP_ERROR_CHECK failed: esp_err_t 0x%x", rc); #ifdef CONFIG_ESP_ERR_TO_NAME_LOOKUP ets_printf(" (%s)", esp_err_to_name(rc)); #endif //CONFIG_ESP_ERR_TO_NAME_LOOKUP ets_printf(" at 0x%08x\n", (intptr_t)__builtin_return_address(0) - 3); if (spi_flash_cache_enabled()) { // strings may be in flash cache ets_printf("file: \"%s\" line %d\nfunc: %s\nexpression: %s\n", file, line, function, expression); } } #define ERROR_RETURN(x, fail) do { \ esp_err_t __err_rc = (x); \ if (__err_rc != ESP_OK) { \ _error_check_failed(__err_rc, __FILE__, __LINE__, \ __ASSERT_FUNC, #x); \ return fail; \ } \ } while(0); ////////////////////////////////////////////////////////////////////// // Sensor Function int cmp_volt(const uint32_t *a, const uint32_t *b) { if (*a < *b) { return -1; } else if (*a == *b) { return 0; } else { return 1; } } uint32_t get_battery_voltage(void) { uint32_t ad_volt_list[BATTERY_ADC_SAMPLE]; esp_adc_cal_characteristics_t characteristics; adc1_config_width(ADC_WIDTH_BIT_12); adc1_config_channel_atten(BATTERY_ADC_CH, ADC_ATTEN_11db); esp_adc_cal_characterize(ADC_UNIT_1, ADC_ATTEN_DB_11, ADC_WIDTH_BIT_12, ADC_VREF, &characteristics); for (uint32_t i = 0; i < BATTERY_ADC_SAMPLE; i++) { ESP_ERROR_CHECK(esp_adc_cal_get_voltage(BATTERY_ADC_CH, &characteristics, ad_volt_list + i)); } qsort(ad_volt_list, BATTERY_ADC_SAMPLE, sizeof(uint32_t), (int (*)(const void *, const void *))cmp_volt); // mean value return ad_volt_list[BATTERY_ADC_SAMPLE >> 1] * BATTERY_ADC_DIV; } ////////////////////////////////////////////////////////////////////// // Fluentd Function static int connect_server() { struct sockaddr_in server; int sock; sock = socket(AF_INET, SOCK_STREAM, 0); server.sin_family = AF_INET; server.sin_port = htons(FLUENTD_PORT); server.sin_addr.s_addr = inet_addr(FLUENTD_IP); if (connect(sock, (struct sockaddr *)&server, sizeof(server)) != 0) { ESP_LOGE(TAG, "FLUENTD CONNECT FAILED errno=%d", errno); return -1; } ESP_LOGI(TAG, "FLUENTD CONNECT SUCCESS"); return sock; } static cJSON *sense_json(uint32_t battery_volt, wifi_ap_record_t *ap_record, uint32_t wifi_con_msec) { sense_data_t *sense_data = (sense_data_t *)&ulp_sense_data; cJSON *root = cJSON_CreateArray(); for (uint32_t i = 0; i < ulp_sense_count; i++) { cJSON *item = cJSON_CreateObject(); uint32_t index = ulp_sense_count - i - 1; cJSON_AddNumberToObject(item, "rain", sense_data[i].rainfall * 0.5); cJSON_AddStringToObject(item, "hostname", WIFI_HOSTNAME); cJSON_AddNumberToObject(item, "self_time", SENSE_INTERVAL * index); // negative offset if (index == 0) { cJSON_AddNumberToObject(item, "battery", battery_volt); cJSON_AddNumberToObject(item, "wifi_ch", ap_record->primary); cJSON_AddNumberToObject(item, "wifi_rssi", ap_record->rssi); cJSON_AddNumberToObject(item, "wifi_con_msec", wifi_con_msec); if (ulp_sense_count < SENSE_BUF_FULL) { cJSON_AddNumberToObject(item, "retry", 0); } else { cJSON_AddNumberToObject(item, "retry", ulp_sense_count - SENSE_BUF_FULL); } } cJSON_AddItemToArray(root, item); } return root; } static bool process_sense_data(uint32_t connect_msec, uint32_t battery_volt) { wifi_ap_record_t ap_record; char buffer[sizeof(EXPECTED_RESPONSE)]; bool result = false; ERROR_RETURN(esp_wifi_sta_get_ap_info(&ap_record), false); int sock = connect_server(); if (sock == -1) { return false; } cJSON *json = sense_json(battery_volt, &ap_record, connect_msec); char *json_str = cJSON_PrintUnformatted(json); do { if (dprintf(sock, REQUEST, strlen("json=") + strlen(json_str), json_str) < 0) { ESP_LOGE(TAG, "FLUENTD POST FAILED"); break; } bzero(buffer, sizeof(buffer)); read(sock, buffer, sizeof(buffer)-1); if (strcmp(buffer, EXPECTED_RESPONSE) != 0) { ESP_LOGE(TAG, "FLUENTD POST FAILED"); break; } ESP_LOGI(TAG, "FLUENTD POST SUCCESSFUL"); result = true; } while (0); close(sock); cJSON_Delete(json); return result; } ////////////////////////////////////////////////////////////////////// // Wifi Function static esp_err_t event_handler(void *ctx, system_event_t *event) { switch(event->event_id) { case SYSTEM_EVENT_STA_START: ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START"); ERROR_RETURN(tcpip_adapter_set_hostname(TCPIP_ADAPTER_IF_STA, WIFI_HOSTNAME), ESP_FAIL); ERROR_RETURN(esp_wifi_connect(), ESP_FAIL); break; case SYSTEM_EVENT_STA_GOT_IP: ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP"); xSemaphoreGive(wifi_conn_done); break; case SYSTEM_EVENT_STA_DISCONNECTED: ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED"); xSemaphoreGive(wifi_conn_done); break; default: break; } return ESP_OK; } static bool wifi_init() { esp_err_t ret; ret = nvs_flash_init(); if (ret == ESP_ERR_NVS_NO_FREE_PAGES) { ERROR_RETURN(nvs_flash_erase(), false); ret = nvs_flash_init(); } ERROR_RETURN(ret, false); tcpip_adapter_init(); ERROR_RETURN(esp_event_loop_init(event_handler, NULL), false); wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); ERROR_RETURN(esp_wifi_init(&cfg), false); ERROR_RETURN(esp_wifi_set_mode(WIFI_MODE_STA), false); #ifdef WIFI_SSID wifi_config_t wifi_config = { .sta = { .ssid = WIFI_SSID, .password = WIFI_PASS, }, }; wifi_config_t wifi_config_cur; ERROR_RETURN(esp_wifi_get_config(WIFI_IF_STA, &wifi_config_cur), false); if (strcmp((const char *)wifi_config_cur.sta.ssid, (const char *)wifi_config.sta.ssid) || strcmp((const char *)wifi_config_cur.sta.password, (const char *)wifi_config.sta.password)) { ESP_LOGI(TAG, "SAVE WIFI CONFIG"); ERROR_RETURN(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config), false); } #endif return true; } static bool wifi_connect() { xSemaphoreTake(wifi_conn_done, portMAX_DELAY); ERROR_RETURN(esp_wifi_start(), false); if (xSemaphoreTake(wifi_conn_done, WIFI_CONNECT_TIMEOUT * 1000 / portTICK_RATE_MS) == pdTRUE) { return true; } else { ESP_LOGE(TAG, "WIFI CONNECT TIMECOUT"); return false; } } static bool wifi_stop() { esp_wifi_disconnect(); esp_wifi_stop(); return true; } ////////////////////////////////////////////////////////////////////// // ULP Function static void init_ulp_program() { ESP_ERROR_CHECK( ulp_load_binary( 0, ulp_main_bin_start, (ulp_main_bin_end - ulp_main_bin_start) / sizeof(uint32_t) ) ); ulp_gpio_num = GAUGE_PIN_ULP; ulp_predecessing_zero = true; ESP_ERROR_CHECK(rtc_gpio_init(GAUGE_PIN)); rtc_gpio_set_direction(GAUGE_PIN, RTC_GPIO_MODE_INPUT_ONLY); rtc_gpio_pulldown_en(GAUGE_PIN); rtc_gpio_pullup_dis(GAUGE_PIN); rtc_gpio_hold_en(GAUGE_PIN); REG_SET_FIELD(SENS_ULP_CP_SLEEP_CYC0_REG, SENS_SLEEP_CYCLES_S0, rtc_clk_slow_freq_get_hz()); // MEMO: EDP-IDF のサンプル(ulp_example_main.c)にある下記を， // 両端子共に open の手元の ESP32 に行うと消費電流がulp_set_wakeup_period増えた．詳細不明． /* GPIO12: select flash voltage */ /* GPIO15: suppress boot messages */ /* rtc_gpio_isolate(GPIO_NUM_12); */ /* rtc_gpio_isolate(GPIO_NUM_15); */ } ////////////////////////////////////////////////////////////////////// // Sensing static bool sense_data_all_zero() { sense_data_t *sense_data = (sense_data_t *)&ulp_sense_data; for (uint32_t i = 0; i < ulp_sense_count; i++) { if (sense_data[i].rainfall != 0) { return false; } } return true; } static bool handle_ulp_sense_data() { uint16_t edge_count; edge_count = ulp_edge_count; ulp_edge_count = 0; sense_data_t *sense_data = (sense_data_t *)&ulp_sense_data; sense_data[ulp_sense_count++].rainfall = edge_count; ESP_LOGI(TAG, "SENSE_COUNT: %d / %d", ulp_sense_count, SENSE_BUF_FULL); if (edge_count != 0) { ESP_LOGW(TAG, "EDGE_COUNT = %d", edge_count); } // check if it began to rain if ((edge_count != 0) && ulp_predecessing_zero) { ulp_predecessing_zero = false; return true; } // check if it is raining and buffer is filled if ((ulp_sense_count >= SENSE_BUF_COUNT) && (!sense_data_all_zero())) { ulp_predecessing_zero = false; return true; } // check if the buffer is full if (ulp_sense_count >= SENSE_BUF_FULL) { ulp_predecessing_zero = sense_data_all_zero(); return true; } return false; } ////////////////////////////////////////////////////////////////////// void app_main() { uint32_t time_start; uint32_t battery_volt; uint32_t connect_msec; #ifdef ADC_CALIB_MODE ESP_ERROR_CHECK(adc2_vref_to_gpio(GPIO_NUM_25)); #else vSemaphoreCreateBinary(wifi_conn_done); battery_volt = get_battery_voltage(); esp_log_level_set("wifi", ESP_LOG_ERROR); if (esp_sleep_get_wakeup_cause() == ESP_SLEEP_WAKEUP_TIMER) { ulp_sense_count = ulp_sense_count & 0xFFFF; // mask if (handle_ulp_sense_data()) { bool status = false; ESP_LOGI(TAG, "Send to fluentd"); time_start = xTaskGetTickCount(); if (wifi_init() && wifi_connect()) { connect_msec = (xTaskGetTickCount() - time_start) * portTICK_PERIOD_MS; status = process_sense_data(connect_msec, battery_volt); } wifi_stop(); if (status) { ulp_sense_count = 0; } else if (ulp_sense_count >= SENSE_BUF_MAX) { // count has reached max ulp_sense_count = 0; } } } else { init_ulp_program(); ulp_sense_count = 0; ulp_set_wakeup_period(0, 1000*30); // 30ms ESP_ERROR_CHECK(ulp_run((&ulp_entry - RTC_SLOW_MEM) / sizeof(uint32_t))); } ESP_LOGI(TAG, "Go to sleep"); ESP_ERROR_CHECK(esp_sleep_enable_timer_wakeup(SENSE_INTERVAL * 1000000LL)); vTaskDelay(20 / portTICK_RATE_MS); // wait 20ms for flush UART esp_deep_sleep_start(); #endif } |
組み上げ
雨量計とソフトを組み込んだ回路を接続すれば完成．
しばらく時間がたつと Grafana にデータが溜まり始めます．
コメント