Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add SetWaveform message; useful for notifications #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add SetWaveform message; useful for notifications #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions messages/light.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [Light messages](#light-messages) - message type value
* [Get - 101](#get---101)
* [SetColor - 102](#setcolor---102)
* [SetWaveform - 103](#setwaveform---103)
* [State - 107](#state---107)
* [GetPower - 116](#getpower---116)
* [SetPower - 117](#setpower---117)
Expand All @@ -33,6 +34,21 @@ The [Protocol header](../header.md#protocol-header) _message type_ field value
Each section below describes the _payload_ that is appended to the
[message header](../header.md). Some messages do not require a payload.

## Enumerated types

### Waveform

Describes the type of flashing pattern used in the
[SetWaveform](#setwaveform---103) message.

| Type | Value |
|----------|-------|
| Saw | 0 |
| Sine | 1 |
| HalfSine | 2 |
| Triangle | 3 |
| Pulse | 4 |

## Message field data types

### HSBK
Expand Down Expand Up @@ -86,6 +102,34 @@ The _duration_ is the color transition time in milliseconds.
If the [Frame Address](../header.md#frame-address) _res\_required_ field is
set to one (1) then the device will transmit a [State](#state---107) message.

### SetWaveform - 103

Sent by a client to cause the light to display a configurable flashing
pattern, such as used by the "pulse" and "breathe" effects in the HTTP
API.

| Field | Type |
|------------|-------------------------------------------------------|
| reserved | unsigned 8-bit integer |
| transient | unsigned 8-bit integer, interpreted as boolean |
| color | HSBK |
| period | unsigned 32-bit integer |
| cycles | 32-bit float |
| duty_cycle | signed 16-bit integer |
| waveform | unsigned 8-bit integer, maps to [Waveform](#waveform) |

If _transient_ is 1, the color returns to the original color of the
light, after the specified number of _cycles_. If _transient_ is
0, the light is left set to _color_ after the specified number of
_cycles_.

The _period_ is the length of one cycle in milliseconds.

If _duty_cycle_ is 0, an equal amount of time is spent on the original
color and the new _color_. If _duty_cycle_ is positive, more time is
spent on the original color. If _duty_cycle_ is negative, more time
is spent on the new color.

### State - 107

Sent by a device to provide the current light state.
Expand Down