jess
/
cs-midi-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove BLE-specific framing from docs

This commit is contained in:
pszsh 2026-03-04 03:26:32 -08:00
parent fe877262d1
commit 52f0d1282d
3 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/_index.md
View File

@ -1,14 +1,13 @@
# cs-midi # cs-midi
A standalone pico-sdk extraction of [tttapa/Control-Surface](https://github.com/tttapa/Control-Surface) (GPL-3.0). A pico-sdk port of [tttapa/Control-Surface](https://github.com/tttapa/Control-Surface) (GPL-3.0).
cs-midi provides the core MIDI element system, BLE MIDI transport, banks, selectors, and the declarative `Control_Surface` singleton for use with the Raspberry Pi Pico SDK and the CYW43 radio module (BTstack BLE backend). cs-midi provides the full Control Surface MIDI element system — output elements, input elements, banks, selectors, MIDI routing, and the declarative `Control_Surface` singleton — for use with the Raspberry Pi Pico SDK.
## Getting Started ## Getting Started
```cpp ```cpp
#include "pico/stdlib.h" #include "pico/stdlib.h"
#include "pico/cyw43_arch.h"
#include <cs_midi.h> #include <cs_midi.h>
using namespace cs; using namespace cs;
@ -19,7 +18,6 @@ NoteButton button {5, {MIDI_Notes::C[4], Channel_1}};
int main() { int main() {
stdio_init_all(); stdio_init_all();
if (cyw43_arch_init()) return 1;
Control_Surface.begin(); Control_Surface.begin();
while (true) { while (true) {
Control_Surface.loop(); Control_Surface.loop();
@ -31,10 +29,9 @@ int main() {
## Differences from Control Surface ## Differences from Control Surface
- `#include <cs_midi.h>` replaces `#include <Control_Surface.h>` - `#include <cs_midi.h>` replaces `#include <Control_Surface.h>`
- `cs::BluetoothMIDI_Interface` replaces `USBMIDI_Interface` - Standard `main()` replaces Arduino `setup()`/`loop()`
- Standard `main()` with `cyw43_arch_init()` replaces Arduino `setup()`/`loop()`
- All types live in the `cs::` namespace - All types live in the `cs::` namespace
- No `MCU::` namespace — use raw CC numbers or `MIDI_CC::` constants - No `MCU::` namespace yet — use raw CC numbers or `MIDI_CC::` constants
## Credits ## Credits

2
docs/classes.md
View File

@ -82,7 +82,7 @@ These classes are available in cs-midi and work identically to their Control Sur
| Class | Template | Description | | Class | Template | Description |
|-------|----------|-------------| |-------|----------|-------------|
| `BluetoothMIDI_Interface` | | BLE MIDI via CYW43 BTstack | | `BluetoothMIDI_Interface` | | BLE MIDI interface |
### MIDI Routing ### MIDI Routing

2
docs/examples/03-interfaces/01-ble-midi.md
View File

@ -1,6 +1,6 @@
# BLE MIDI # BLE MIDI
Basic Bluetooth Low Energy MIDI interface setup. Replaces `USBMIDI_Interface` from the original library. Bluetooth Low Energy MIDI interface setup.
```cpp ```cpp
#include "pico/stdlib.h" #include "pico/stdlib.h"