Further Motor documentation

This commit is contained in:
ZodiusInfuser 2022-05-09 18:19:48 +01:00
parent 13ac475b7c
commit 3bbf733bfb
1 changed files with 21 additions and 1 deletions

View File

@ -57,13 +57,20 @@ This library offers two motor implementations:
- [MotorCluster](#motorcluster)
- [Getting Started](#getting-started-1)
- [Control by Speed](#control-by-speed-1)
- [Full Speed](#full-speed-1)
- [Stopping](#stopping-1)
- [Calibration](#calibration-1)
- [Control by Percent](#control-by-percent-1)
- [Control by Duty Cycle](#control-by-duty-cycle-1)
- [Duty Deadzone](#duty-deadzone-1)
- [Frequency Control](#frequency-control-1)
- [Phase Control](#phase-control)
- [Configuration](#configuration-1)
- [Direction](#direction-1)
- [Decay Mode](#decay-mode-1)
- [Delayed Loading](#delayed-loading)
- [Function Reference](#function-reference-1)
- [Function Reference](#function-reference)
- [Constants Reference](#constants-reference)
- [PIO Limitations](#pio-limitations)
@ -821,6 +828,19 @@ all_decay_modes(mode, load=True)
```
### Constants Reference
Here is the complete list of constants on the `motor` module:
* `FAST_DECAY` = `0`
* `SLOW_DECAY` = `1`
Here are useful constants from the `pimoroni` module:
* `NORMAL_DIR` = `0`
* `REVERSED_DIR` = `1`
### PIO Limitations
The RP2040 features two PIOs with four state machines each. This places a hard limit on how many MotorClusters can be created. As this class is capable of driving all 30 GPIO pins, the only time this limit will be of concern is when motors with different frequencies are wanted, as all the outputs a MotorCluster controls share the same frequency. Relating this to the hardware PWM, think of it as a single PWM slice with up to 30 sub channels, A, B, C, D etc.