Skip to content

Commit

Permalink
Update the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
mairas committed Sep 25, 2024
1 parent 9eae629 commit 088528a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@
- `ExpiringValue`: output value expires after a given time unless updated
- `Repeat`: repeats the input value at a given interval
- `RepeatStopping`: repeats the input value at a given interval, stopping after a given time
- `RepeatExpiring`: repeats the input value at a given interval, expiring after a given time
- `RepeatConstantRate`: repeats the input value at a constant rate, regardless of input rate
- `RepeatExpiring`: repeats the input value at a given interval, expiring after a given time.
`RepeatExpiring` outputs an `Nullable<T>` value, where the value is invalid/`null` after expiration.
- `RepeatConstantRate`: repeats the input value at a constant rate, regardless of input rate.
`RepeatConstantRate` outputs an `Nullable<T>` value, where the value is invalid/`null` after expiration.
- `Join`: joins multiple input values into a single output tuple that is emitted when any inputs are updated
- `Zip`: joins multiple input values into a single output tuple that is emitted when all inputs are updated
- `Throttle`: limits the rate of output updates
Expand All @@ -52,6 +54,12 @@
It now writes its output to a JsonDocument reference instead
of returning a String.

- Custom Signal K output is done differently than before. Instead of implementing
an `as_signalk()` method in your `SKOutput` specialization that returned a
serialized string, you should
implement an `as_signalk_json()` method that writes constructs an ArduinoJson
object in the provided `JsonObject` reference.

### Migrating Existing Projects

- Update your project's `platformio.ini` file to use the new version of SensESP:
Expand Down

0 comments on commit 088528a

Please sign in to comment.