Skip to content

Latest commit

 

History

History
209 lines (149 loc) · 7.05 KB

README.md

File metadata and controls

209 lines (149 loc) · 7.05 KB
Raw

mqtt-state

v4 - breaking change

v4 marks a change in direction from v3.

Since the only real audience for this project are people who can write code, it seemed constrained to have to join basic rules together for something that would be a single line of code.

Also the only way to conditionally emit was with a filter rule, which seemed limited, and generally meant a bunch of chaining.

Being able to achieve both in a small amount of code seemed like a much better approach, so this version ditches the defined rule types, each rule will need code... however the code for each rule should be very simple. The test cases demonstrate code for most of the old rules. In many ways it is easier to follow, document, and definitely more powerful.

For now refer to tests for examples on usage. Almost all previous rules have been replicated there.

Pros with v4:

  • A rule can conditionally emit, previously only filter rule could conditionally emit but it couldn't transform data.
  • A rule can emit multiple times from a single source event.
  • A rule can have more complex logic with needing to chain rules.
  • A rule can emit many child topics or keys, allowing a single source to be split into multiple output values/topics from a single rule.
  • A rule can have technically have async logic, although beware of sequence issues.

Note: distinct, debounce and throttle are now properties on a rule:

  • distinct will only save and emit changes if the value changes from before. Note must be === exact match.
  • debounce will only save and emit after receiving no events for the interval, good for squashing bursts into a single change, but if the flow of events is constant there may never be a break long enough to process the change.
  • throttle will save an emit immediately, but then only emit once per interval. The last even while throttling is occurring will be saved and emitted once the throttle window expires.

Limitations:

  1. When a rule emits child values metrics won't work as expected. Don't use metrics with such rules yet.
  2. There is no cache from previous rule runs. You can access the last output of any other rule, including the current rules' child values so you could probably hack it. Because of this have't been able to figure out how to reproduce activity.

Config

TBD

TODO: allow config to be passed in via params

Rules

Source

The source for each rule is Javascript code. This is executed by whatever version of Node js is running the process, so a newer version will have access to more syntax etc.

The following globals are defined in the rule scope/context:

  • key: string - the unique key for this rule
  • set(value: any) - function to set the next value for the key. If this is not called during the rule execution then the value will remain unchanged.
  • setChild(subkey: string, value: any) - function to set a value on a subkey. You can set many child values on a single rule execution.
  • currentValue: string - The current (last known) value of this rule (ie the last value passed into the set function).
  • subscriptions: string[] - a list of keys this rule is subscribed to. Sometimes useful to iterate over.
  • event: { key: string, value: any } - the event that triggered this rule execution. If many events are subscribed to the key may be used to check which one it is.
  • console: Console - the usual Node js console
  • state: { get, getMany } - an object with a get and getMany function to get one or more values from the current active state by their string keys. This includes any subscribed MQTT events by their topic (key)

Ticker

Internal ticker events are fired every second on ticker/tick.

If a rule subscribes to this it will execute every second.

Alternatively you can subscribe to ticker/minute (one per minute), ticker/quarter (once per 15min), ticker/hour (once per hour).

Each tick event contains a body with the following integer fields:

  • time: milliseconds since epoch
  • hour: hour of the day (0-23)
  • minute: minute of the hour (0-59)
  • quarter: quarter of the hour (0/15/30/45)
  • day: day of month (1-31)
  • month: month of year (1-12)
  • year: full year (2022+)
  • dayOfWeek: (1-7)

Eg:

{
  time: 1654431900661,
  hour: 22,
  minute: 25,
  quarter: 15,
  day: 5,
  month: 6,
  year: 2022,
  dayOfWeek: 1
}

Templates

When you find yourself entering the same source for many rules you can use templates instead, and just reference the shared source code by ID. For examples:

templates:
  - id: not
    source: set(!event.value)
rules:
  - key: is_dark
    subscribe: is_light
    template: not

Often the source will need values to be useful. When this is the case you can use params to define these values rather than hard coding them into the source. For example:

templates:
  - id: too_hot
    source: set(event.value > params.threshold)
rules:
  - key: bath_too_hot
    subscribe: bath_temperature
    template: too_hot
    params:
      threshold: 40
  - key: soup_too_hot
    subscribe: soup_temperature
    template: too_hot
    params:
      threshold: 60

Included Templates

The following templates are included out-of-the-box. You may override them if desired.

  • alias
  • pick
  • inside
  • within
  • outside
  • above
  • below
  • counter
  • bool
  • not
  • toggle

Example Rules

Turn Off After Lapse in Activity

Subscribe to one or more events.

Turn on as soon as any event is received.

Stays on as long as events are continued to be received.

After a timeout period has elapsed without any events then it will turn off.

Any events other than ticker/tick will be considered triggers.

It does however mean that the returned value is an object, rather than a simple true/false.

key: "presence-detected"
source: |
  const timeout = 30000;

  if (currentValue?.active) {
    // has it ticked past the timeout?
    if (event.name === 'ticker/tick' && Date.now() > currentValue.inactiveAt) {
      set({active: false});
    }
  } else if (event.name !== 'ticker/tick') {
    set({
      active: true,
      inactiveAt: Date.now() + timeout,
    });
  }
subscribe:
  - ticker/tick
  - motion1/detected
  - motion2/detected
  - motion3/detected

HTTP Server

HTTP server can be enabled be specifying a http config in the YAML.

http:
  port: 8080

When running the server will expose the following endpoints:

  • /metrics - Prometheus metrics for all rules. Can be scraped into Prometheus and used to create dashboards and view historical timelines.
  • /state/:key - The current value of a single rule. Can be in HTML or JSON format depending on the Accept header.
  • /state - The current values of all rules. Can be in HTML or JSON format depending on the Accept header.
  • /state?select=key1,key2 - The current values of the specified rules. Can be in HTML or JSON format depending on the Accept header.

TODO: allow listing the current rules and their keys.

To Document

Reusing metrics via config.metrics

Configuring MQTT. Subscribing.

Logging.

Data persistence.

Templates and rules. Template can also include details such as metrics on children since the values published are also controlled by them