{"id":20186634,"url":"https://github.com/zimbora/esp32-alarm","last_synced_at":"2025-03-03T06:46:15.365Z","repository":{"id":162040888,"uuid":"557953116","full_name":"zimbora/esp32-alarm","owner":"zimbora","description":"package to detect values outside a defined range","archived":false,"fork":false,"pushed_at":"2023-11-04T18:25:57.000Z","size":176,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-13T18:18:01.718Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zimbora.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-26T16:02:11.000Z","updated_at":"2022-10-26T16:19:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"99b958ff-2635-443f-90b3-7767c46e25a5","html_url":"https://github.com/zimbora/esp32-alarm","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimbora%2Fesp32-alarm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimbora%2Fesp32-alarm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimbora%2Fesp32-alarm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimbora%2Fesp32-alarm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zimbora","download_url":"https://codeload.github.com/zimbora/esp32-alarm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241622594,"owners_count":19992502,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T03:18:02.507Z","updated_at":"2025-03-03T06:46:15.328Z","avatar_url":"https://github.com/zimbora.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esp32-alarm\n\n## Description\npackage to detect values outside of a defined range\n\n## Implementation\nAlarms are stored in a JsonDocument with the following structure\n```\n  doc_alarm = {[\n    ref : {\n       \"min\" : min_value,\n       \"max\" : max_value,\n       \"d\" : bool, // use differencial values (actual value oldest value),\n       \"t\" : bool, // alarm triggered\n       \"o\" : last_value\n     }]\n  }\n```\n## Public Methods\n[bool add(String ref, long min, long max, int8_t diff = 0)](#Add-object-1)\n\n[bool add(JsonObject obj)](#Add-object-2)\n\n[bool check(String ref, uint8_t type, JsonObject value)](#Check-Alarm-1)\n\n[bool check(String ref, uint8_t type, bool(*callback)(String))](#Check-Alarm-2)\n\n[void list()](#List)\n\n[JsonObject get(String ref)](#Get)\n\n## Examples\n  Run programs inside examples folder to check how it works\n### demo\n  Add alarms and then check it forever\n### demo_callback\n  Add alarms and then check it forever. If alarm state was changed call registered callback\n### test_limits\n  Check how many alarms can be handled with actual parameters\n\n## Unit Test with clang\n  \u003e\u003e chmod u+x make.sh\n\n  \u003e\u003e ./make.sh\n\n  If needed uncomment DEBUG FLAGS in Makefile\n\n## TODO\n  UnitTest for add methods.. However, it can be tested with examples running on esp32..\n\n## Public Methods - Extension\n\n### Add object 1\nreturn true if has succeed\n```\nbool ALARM::add(String ref, long min, long max, int8_t diff = 0)\n```\n#### Example\n```\n  if(!Alarm.add(\"sensor2\",12,20,0)){\n    Serial.println(\"!! Error adding sensor2 alarm\");\n  }\n```\n### Add object 2\nreturn true if has succeed\n```\nbool ALARM::add(JsonObject obj)\n```\n```\n  obj = {\n    \"ref\"       : \u003cstring\u003e,\n    \"min_value\" : \u003cnumber\u003e,\n    \"max_value\" : \u003cnumber\u003e,\n    \"diff\"      : \u003cnumber\u003e // 1 to use the difference between current and last value, 0 - otherwise\n }\n ```\n\n#### Example\n\n```\n  StaticJsonDocument\u003c64\u003e doc_object;\n\n  doc_object[\"ref\"] = \"sensor1\";\n  doc_object[\"min_value\"] = 2;\n  doc_object[\"max_value\"] = 12;\n  doc_object[\"diff\"] = 0;\n\n  JsonObject obj = doc_object.as\u003cJsonObject\u003e();\n\n  Alarm.add(obj);\n```\n\n### Check Alarm 1\nreturn true if is in alarm\n```\nbool ALARM::check(String ref, uint8_t type, JsonObject value)\n```\n#### Example\n```\n  DynamicJsonDocument table(220);\n  String ref = \"sensor1\"\n  table[ref] = rand;\n  JsonObject data = table.as\u003cJsonObject\u003e();\n\n  Alarm.check(ref,int32be_type,data);\n```\n\n### Check Alarm 2\nreturn true if is in alarm\n\ncall callback function if alarm goes out of the range limit or returns to the range limit\n```\nbool ALARM::check(String ref, uint8_t type, bool(*callback)(String))\n```\n#### Example\n```\nbool (*callback)(String);\nbool calledInAlarm(String ref){\n  Serial.println(\"alarm was changed\");\n  return true;\n}\n\nDynamicJsonDocument table(220);\nString ref = \"sensor1\"\ntable[ref] = rand;\nJsonObject data = table.as\u003cJsonObject\u003e();\n\ncallback = \u0026calledInAlarm;\nAlarm.check(ref,int32be_type,data,callback);\n```\n\n### List\n\n```\nvoid ALARM::list()\n```\n#### Example\n```\n  Alarm.list();\n```\n\n### Get\n\n```\nJsonObject ALARM::get(String ref)\n```\n#### Example\n```\n  JsonObject object = Alarm.get(\"sensor1\");\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzimbora%2Fesp32-alarm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzimbora%2Fesp32-alarm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzimbora%2Fesp32-alarm/lists"}