Skip to content

Commit

Permalink
Provide update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pgrawehr committed Dec 28, 2022
1 parent 401b05c commit 85b0819
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,28 @@ Firmata is a protocol for communicating with microcontrollers from software on a

## Release 3.0

ConfigurableFirmata 3.0 contains some internal breaking changes for external modules. If you need to use a particular module (such as FirmataEncoder), either use a 2.xx version or ask the maintainer to update the module to work with V3.0.
ConfigurableFirmata 3.0 contains some internal breaking changes for external modules. If you need to use a particular module (such as FirmataEncoder), either use a 2.xx version or ask the maintainer to update the module to work with V3.0.

If you have a sketch prepared for an older version of ConfigurableFirmata (< v3.0), you should either restart with the basic example (from the examples directory) or perform the following steps to adjust your sketch to the new library version:

- Remove the line `#include <AnalogWrite.h>`
- Replace the `loop()` function with this snippet:

```cpp
void loop()
{
while(Firmata.available()) {
Firmata.processInput();
if (!Firmata.isParsingMessage()) {
break;
}
}

firmataExt.report(reporting.elapsed());
}
```

It's no longer necessary to call `update()` for every module that requires polling. That is now handled by the above call to `report`.

## Usage

Expand Down

0 comments on commit 85b0819

Please sign in to comment.