https://github.com/zimbora/esp32-alarm

package to detect values outside a defined range
https://github.com/zimbora/esp32-alarm

Last synced: 2 days ago
JSON representation

package to detect values outside a defined range

• Host: GitHub
• URL: https://github.com/zimbora/esp32-alarm
• Owner: zimbora
• License: apache-2.0
• Created: 2022-10-26T16:02:11.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T18:25:57.000Z (about 1 year ago)
• Last Synced: 2024-04-29T22:42:00.949Z (7 months ago)
• Language: C++
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# esp32-alarm

## Description

package to detect values outside of a defined range

## Implementation

Alarms are stored in a JsonDocument with the following structure

```

  doc_alarm = {[

    ref : {

       "min" : min_value,

       "max" : max_value,

       "d" : bool, // use differencial values (actual value oldest value),

       "t" : bool, // alarm triggered

       "o" : last_value

     }]

  }

```

## Public Methods

[bool add(String ref, long min, long max, int8_t diff = 0)](#Add-object-1)

[bool add(JsonObject obj)](#Add-object-2)

[bool check(String ref, uint8_t type, JsonObject value)](#Check-Alarm-1)

[bool check(String ref, uint8_t type, bool(*callback)(String))](#Check-Alarm-2)

[void list()](#List)

[JsonObject get(String ref)](#Get)

## Examples

  Run programs inside examples folder to check how it works

### demo

  Add alarms and then check it forever

### demo_callback

  Add alarms and then check it forever. If alarm state was changed call registered callback

### test_limits

  Check how many alarms can be handled with actual parameters

## Unit Test with clang

  >> chmod u+x make.sh

  >> ./make.sh

  If needed uncomment DEBUG FLAGS in Makefile

## TODO

  UnitTest for add methods.. However, it can be tested with examples running on esp32..

## Public Methods - Extension

### Add object 1

return true if has succeed

```

bool ALARM::add(String ref, long min, long max, int8_t diff = 0)

```

#### Example

```

  if(!Alarm.add("sensor2",12,20,0)){

    Serial.println("!! Error adding sensor2 alarm");

  }

```

### Add object 2

return true if has succeed

```

bool ALARM::add(JsonObject obj)

```

```

  obj = {

    "ref"       : ,

    "min_value" : ,

    "max_value" : ,

    "diff"      :  // 1 to use the difference between current and last value, 0 - otherwise

 }

 ```

#### Example

```

  StaticJsonDocument<64> doc_object;

  doc_object["ref"] = "sensor1";

  doc_object["min_value"] = 2;

  doc_object["max_value"] = 12;

  doc_object["diff"] = 0;

  JsonObject obj = doc_object.as();

  Alarm.add(obj);

```

### Check Alarm 1

return true if is in alarm

```

bool ALARM::check(String ref, uint8_t type, JsonObject value)

```

#### Example

```

  DynamicJsonDocument table(220);

  String ref = "sensor1"

  table[ref] = rand;

  JsonObject data = table.as();

  Alarm.check(ref,int32be_type,data);

```

### Check Alarm 2

return true if is in alarm

call callback function if alarm goes out of the range limit or returns to the range limit

```

bool ALARM::check(String ref, uint8_t type, bool(*callback)(String))

```

#### Example

```

bool (*callback)(String);

bool calledInAlarm(String ref){

  Serial.println("alarm was changed");

  return true;

}

DynamicJsonDocument table(220);

String ref = "sensor1"

table[ref] = rand;

JsonObject data = table.as();

callback = &calledInAlarm;

Alarm.check(ref,int32be_type,data,callback);

```

### List

```

void ALARM::list()

```

#### Example

```

  Alarm.list();

```

### Get

```

JsonObject ALARM::get(String ref)

```

#### Example

```

  JsonObject object = Alarm.get("sensor1");

```