Skip to content

Commit

Permalink
📝 Fix API for constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
marvinroger committed Nov 14, 2017
1 parent 4a508e0 commit b6edf4d
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,9 @@ to make the shutters go halfway (50%) for example. So I built this library.

See examples folder for examples.

#### Shutters (void (\*`upCallback`)(Shutters* shutters), void (\*`downCallback`)(Shutters* shutters), void (\*`haltCallback`)(Shutters* shutters), const char* (\*`getStateCallback`)(Shutters* shutters, byte length), void (\*`setStateCallback`)(Shutters* shutters, const char* state, byte length))
#### Shutters ()

* **`upCallback()`**: Function to execute for the shutters to go up
* **`downCallback()`**: Function to execute for the shutters to go down
* **`haltCallback()`**: Function to execute for the shutters to halt
* **`getStateCallback()`**: Function called to get the stored state. This must return the state char array of the given length
* **`setStateCallback()`**: Function called to set the stored state. Store this in the EEPROM of SPIFFS, etc.
Instantiate a Shutters instance.

#### Shutters& .begin ()

Expand Down

0 comments on commit b6edf4d

Please sign in to comment.