Added documentation of outbound messages

mauer · Oct 27, 2023 · afa8895 · afa8895
1 parent 473f45b
commit afa8895
Showing 1 changed file with 25 additions and 10 deletions.
diff --git a/docs/outbound_mapping.md b/docs/outbound_mapping.md
@@ -24,14 +24,29 @@ mapping_out = [
 ]
 ```
 
-## Common variables
+## Required Parameters
 
-The following variables are required for each mapping.
+The following parameter is required for each mapping.
 
-| Variable | Description                       |
-|----------|-----------------------------------|
-| ch       | MIDI Channel (Default Value = 11) |
+| Parameter | Description                            |
+|-----------|----------------------------------------|
+| ch        | MIDI Channel (Default Value = 11)      |
+| type      | Specifies the mapping type (see below) |  
 
+One of the following parameters is required, depending on the MIDI message type.
+
+| Parameter | MIDI Message Type | Expected Parameter Value |
+|-----------|-------------------|--------------------------|
+| cc        | Control Change    | Control Change No Number |
+| note      | Note On / Off     | Note Number              |
+| pitch     | Pitch Bend        | Pitch Bend Number        |
+| prg       | Program Change    | Program Change Number    |
+
+## Optional Parameters
+
+| Parameter | Description            |
+|-----------|------------------------|
+| sl        | Sublayer               |
 
 ## MIDI Type
 
@@ -47,13 +62,13 @@ A mapping must contains exactly one of the following variables.
 | pitch    | Pitch Bend Number        |
 | prg      | Program Change Number    |
 
-
 ## Mapping Types
 
 The following mapping types are supported:
 
-| Mapping Type |   Name    | Description and usage                                         |
-|:------------:|:---------:|---------------------------------------------------------------|
-|     drf      | Dataref   | Reads the dataref value and sends a MIDI message if necessary |
-|     con      | Constant  | Sends a constant velocity to the MIDI device                  |    
+| Mapping Type |   Name    | Description and usage                                            |
+|:------------:|:---------:|------------------------------------------------------------------|
+|     drf      | Dataref   | Reads the dataref value and sends a MIDI message if necessary    |
+|     con      | Constant  | Sends a constant velocity to the MIDI device                     |
+|     sld      | Slider    | Sends a veloctiy based on a dataref to control motorized sliders |