Skip to content

Commit bc56d8b

Browse files
committed
update readme
1 parent eec6d92 commit bc56d8b

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,12 @@ int update();
110110
111111
## My status indicator is controlled by CAN / I2C / SPI / ... What can I do?
112112
113-
No problem! Just subclass the generic `Indicator` class from `<Indicator.h>` or use it
114-
directly. The `bool Indicator::update()`-method returns a boolean whether the status is
115-
currently `HIGH` or `LOW`. You can then send this value to your status indicator.
113+
No problem! You have two options.
116114
117-
Have a look at `IndicatorPin.h` for a subclassing example or look into
118-
`examples/GenericBlink` for direct usage.
115+
- Use the generic `Indicator` class from `<Indicator.h>`. The `.update()`-method returns
116+
a boolean whether the status is currently `HIGH` or `LOW`. You can then send this
117+
value to your status indicator (see `examples/GenericBlink`). Use the `FadingIndictor`
118+
class if you want fading effects. Here the `update` method returns an integer `0..255`.
119+
120+
- Subclass the `Indicator` class with custom logic. This is what `IndicatorPin` does
121+
internally (see `src/IndicatorPin.h`).

0 commit comments

Comments
 (0)