Skip to content

Commit

Permalink
Better README articulation
Browse files Browse the repository at this point in the history
  • Loading branch information
garubi committed Jan 10, 2024
1 parent 403f072 commit 086d97b
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,17 @@ Simply connect it to the [editor](https://garubi.github.io/push-push-editor/) an

![An animated preview of the Push Push editor](animated-editor-preview.gif)

# MIDI sysex implementation for configuration
# How to build it

## The hardware

## The software

## The configuration

# References

## MIDI sysex implementation for configuration

The communication between Push Push and the editor is based on the MIDI protocol, exchanging System Exclusive Messages.

Expand Down Expand Up @@ -39,23 +49,27 @@ const byte OK = 0x01;
```


Ask the current configuration to Push Push:
### The Editor ask the current configuration to Push Push:

`F0 X_MANID1 X_MANID2 X_PRODID REQ GET F7`

**Push Push answer:**

`REQ GET `
`F0 X_MANID1 X_MANID2 X_PRODID REP GET VERSION_MAJOR VERION_MINOR VERSION_PATCH X_MODELID BUTTON_QTY KEYS_SEQUENCE_SIZE BTN_n_MODIFIER_CODE_1 BTN_n_MODIFIER_CODE_2 BTN_n_MODIFIER_CODE_3 BTN_n_MODIFIER_CODE_4 BTN_n_KEY_CODE [...] F7`

Push Push answer:
### The Editor stores a new configuration in Push Push:

`REPL GET VERSION_MAJOR VERION_MINOR VERSION_PATCH X_MODELID BUTTON_QTY KEYS_SEQUENCE_SIZE BTN_n_MODIFIER_CODE_1 BTN_n_MODIFIER_CODE_2 BTN_n_MODIFIER_CODE_3 BTN_n_MODIFIER_CODE_4 BTN_n_KEY_CODE [...]`
`F0 X_MANID1 X_MANID2 X_PRODID REQ SET VERSION_MAJOR VERION_MINOR VERSION_PATCH X_MODELID BUTTON_QTY KEYS_SEQUENCE_SIZE BTN_n_MODIFIER_CODE_1 BTN_n_MODIFIER_CODE_2 BTN_n_MODIFIER_CODE_3 BTN_n_MODIFIER_CODE_4 BTN_n_KEY_CODE [...] F7`

Store the editor's fields as new configuration in Push Push:
**Push Push answer**

`REQ SET VERSION_MAJOR VERION_MINOR VERSION_PATCH X_MODELID BUTTON_QTY KEYS_SEQUENCE_SIZE BTN_n_MODIFIER_CODE_1 BTN_n_MODIFIER_CODE_2 BTN_n_MODIFIER_CODE_3 BTN_n_MODIFIER_CODE_4 BTN_n_KEY_CODE [...]`
`F0 X_MANID1 X_MANID2 X_PRODID REP SET [OK, FAILED ] F7`

Push Push answer
### Push Push receives a unknown command

`REPL SET [OK, FAILED ]`
**Push Push reply**

# References:
`F0 X_MANID1 X_MANID2 X_PRODID REP X_ERROR F7`

## usbMIDI libraries:

Expand All @@ -66,7 +80,7 @@ Push Push answer

- https://www.partsnotincluded.com/diy-stream-deck-mini-macro-keyboard/

## change board name:
## how to change board name:

- https://forum.arduino.cc/t/multiple-leonardos-as-hid-joystick-how-to-change-the-names/402646

Expand Down

0 comments on commit 086d97b

Please sign in to comment.