wirtz
/
uClock
mirror of https://github.com/midilab/uClock
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md

Browse Source
pull/35/head
Tristan Rowley 8 months ago committed by GitHub
parent 3b2d17f5f8
commit f27ad80231
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 12
      README.md

12
README.md
Unescape View File

@ -20,8 +20,8 @@ The uClock library API operates through attached callback functions mechanism:
5. **setOnClockStart(onClockStartCallback) > onClockStartCallback()** on uClock Start event 5. **setOnClockStart(onClockStartCallback) > onClockStartCallback()** on uClock Start event
6. **setOnClockStop(onClockStopCallback) > onClockStopCallback()** on uClock Stop event 6. **setOnClockStop(onClockStopCallback) > onClockStopCallback()** on uClock Stop event
### Generic mode - for unsupported boards (or avoiding usage of interrupts) ### (optional) Generic mode - for unsupported boards (or avoiding usage of interrupts)
If a supported board isn't detected during compilation then a generic fallback approach will be used that does not utilise any interrupts to ensure accurate timekeeping. This can be useful to port projets to boards that do not have support in uClock yet, or to test if suspected bugs are related to interactions with interrupts or task handling. If a supported board isn't detected during compilation then a generic fallback approach will be used. This does not utilise any interrupts and so does not ensure accurate timekeeping. This can be useful to port your projects to boards that do not have support in uClock yet, or to test if suspected bugs in your code are related to interactions with interrupts or task handling.
You can force this non-interrupt "generic mode" even on supported boards by defining the build flag `USE_UCLOCK_GENERIC`. You can force this non-interrupt "generic mode" even on supported boards by defining the build flag `USE_UCLOCK_GENERIC`.
@ -29,7 +29,7 @@ In order for generic mode to work, you need to add a call to your `loop()` funct
```c++ ```c++
// prototype of // pre-declare this function somewhere, so that compiler knows about it.
void uClockCheckTime(uint32_t micros_time); void uClockCheckTime(uint32_t micros_time);
void loop() { void loop() {
@ -55,12 +55,12 @@ If you are comming from uClock version < 2.0 versions keep attention to the brea
#### Tick resolution and sequencers #### Tick resolution and sequencers
If you have write a sequencer using setClock16PPQNOutput only its ok to just change the API call to setOnStep, but if you were dependent on setClock96PPQNOutput you migth need to review you tick counting system depending on wich PPQN clock resolution you choose. If you have write a sequencer using setClock16PPQNOutput only its ok to just change the API call to setOnStep, but if you were dependent on setClock96PPQNOutput you might need to review your tick-counting system, depending on which PPQN clock resolution you choose.
## Examples ## Examples
You will find more complete examples on examples/ folder: You will find more complete examples in `examples/` folder:
```c++ ```c++
@ -84,7 +84,7 @@ void setup() {
} }
``` ```
Resolutions: set youw own resolution for your clock needs Resolutions: set your own resolution for your clock needs:
1. **PPQN_24** 24 Pulses Per Quarter Note 1. **PPQN_24** 24 Pulses Per Quarter Note
2. **PPQN_48** 48 Pulses Per Quarter Note 2. **PPQN_48** 48 Pulses Per Quarter Note

Write Preview
Loading…
Cancel
Save