IoTManager/lib/TickerScheduler/README.md

# TickerScheduler
Simple scheduler for ESP8266 Arduino based on Ticker

### Initialization

`TickerScheduler(uint size);`

| Param | Description | 
| --- | --- |
|  size  |  Amount of task Tickers to initialize  |

**Example**: 

`TickerScheduler ts(5)`


### Add task

`boolean add(uint i, uint32_t period, tscallback_t f, boolean shouldFireNow = false); `

| Param | Description | 
| --- | --- |
|  i  |  Task ID  |
| period  | Task execution period in ms  |
| f | Task callback |
| shouldFireNow|  `true` if you want to execute task right after first scheduler update or wait next scheduled start |

**Returns**:

`true` - task added sucessfully

`false` - task was not added 

**Example**:

`ts.add(0, 3000, sendData)`

### Execute scheduler in `loop()`

`ts.update()`

### Remove task

`boolean remove(uint i)`

**Returns**:

`true` - task removed sucessfully

`false` - task was not removed

| Param | Description | 
| --- | --- |
|  i  |  Task ID  |

### Enable/Disable task

`boolean enable(uint i)`

`boolean disable(uint i)`

**Returns**:

`true` - task enabled/disabled sucessfully

`false` - task was not enabled/disabled

| Param | Description | 
| --- | --- |
|  i  |  Task ID  |

### Enable / disable all tasks

`void enableAll()`

`void disableAll()`

### TODO

* Task callback parameters support
* ...