-
Notifications
You must be signed in to change notification settings - Fork 1
Commands
Sam Spencer edited this page Nov 10, 2022
·
17 revisions
| Arguments | Description |
|---|---|
| none |
| Response | Description |
|---|---|
deviceModel |
string e.g. "Bridge4"
|
firmwareVersion |
string e.g. "1.0.0.1"
|
hardwareVersion |
string e.g. "1.0.1"
|
uniqueDeviceID |
string 96-bit e.g. "ffffffffffffffffffffffff"
|
deviceName |
string 12 characters e.g. "My Bridge4"
|
profileId |
string 32-bit e.g. "ffffffff"
|
| Arguments | Description | Response |
|---|---|---|
bankUp |
Moves to next device bank | ok |
bankDown |
Moves to previous device bank | ok |
goToBank,x |
Jumps to bank x. Must be a valid bank number (zero indexed). x - int
|
ok* |
toggleFootswitch,x |
Toggles footswitch x. Must be a valid footswitch number (zero indexed). x - int
|
ok* |
deviceRestart |
Resets the microcontroller core. Equivalent to a power cycle | ok |
enterBootloader |
Enters the bootloader for firmware mechanism | ok |
factoryReset |
Erases all local and global settings and restores the device to default configuration | ok |
refreshLeds |
Refreshes all LED states to match current states and/or colour configurations | ok |
refreshDisplay |
Refreshes the display according to current UI and naming | ok |
* If a parameter is out of range, the response will be invalidCommand.
| Arguments | Description | Response |
|---|---|---|
globalSettings |
Requests the global settings | Global settings |
bankSettings,x |
int x - Requests the settings for bank x
|
Bank settings |
bankId,x |
int x - Requests the bank ID for bank x
|
Bank ID |
| Arguments | Description | Response |
|---|---|---|
profileId,s |
string s - 32-bit hex configuration profile ID |
ok |
globalSettings |
Prepares device for incoming global settings | ok |
bankSettings,x |
int x - Prepares device for incoming bank settings on the given bank |
ok |