From 076453da928521dd020f557c2a71d19a198e0c92 Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Fri, 3 Sep 2021 08:13:40 +0100 Subject: [PATCH 1/7] MInor Text Changes --- source/includes/http/_group_device.md | 2 +- source/tcp-index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/http/_group_device.md b/source/includes/http/_group_device.md index 3ad2eff..0ea7625 100644 --- a/source/includes/http/_group_device.md +++ b/source/includes/http/_group_device.md @@ -1 +1 @@ -# Device Informations +# Device Information diff --git a/source/tcp-index.md b/source/tcp-index.md index f16f0ce..3052ed3 100644 --- a/source/tcp-index.md +++ b/source/tcp-index.md @@ -1,5 +1,5 @@ --- -title: Arylic Audio TCP API +title: Arylic Audio TCP API Interface # Languages must be one of: https://git.io/vQNgJ language_tabs: From 37f00aae399c14f0bc8af333adfc96ab973b8bf4 Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Fri, 8 Oct 2021 12:14:32 +0100 Subject: [PATCH 2/7] Create _cmd_playback.md Just a quick example of what it could look like. Q str_player_mode or text_player_mode ? We need to have the discussion about RAKOIT and Non RAKOIT MCU Commands. --- source/includes/tcp/_cmd_playback.md | 42 ++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 source/includes/tcp/_cmd_playback.md diff --git a/source/includes/tcp/_cmd_playback.md b/source/includes/tcp/_cmd_playback.md new file mode 100644 index 0000000..8845854 --- /dev/null +++ b/source/includes/tcp/_cmd_playback.md @@ -0,0 +1,42 @@ +### Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC:&: +``` + +> Example Response: + +```plaintext +OK +``` + +Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. + +Command: `MCU+PAS+RAKOIT:SRC:` + +Parameter | Description +---|--- +`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 + + +### Play Preset Content +> Request format for command: + +```html +MCU+PAS+RAKOIT:PST:& +``` + +> Example response: + +```plaintext +AXX+MEA+RDY +``` +Play Instruction for one of the Programmable Presets (maximum 10) + +Command: `MCU+PAS+RAKOIT:PST:` + +Parameter | Description +---|---|--- +`num_value` | The numeric value of the required Preset
Value range is from `0 - 10` + From fded549860ca5f86472dc080f6f314b463984035 Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Mon, 11 Oct 2021 14:34:29 +0100 Subject: [PATCH 3/7] Creation My Notes --- source/includes/tcp/_cmd_pair_SRC.md | 51 ++++++++++++++++++++ source/includes/tcp/_cmd_query_status.md | 33 +++++++++++++ source/includes/tcp/_cmd_system.md | 57 +++++++++++++++++++++++ source/includes/tcp/_cmd_volume.md | 59 ++++++++++++++++++++++++ source/includes/tcp/_intro_welcome.md | 8 ++++ 5 files changed, 208 insertions(+) create mode 100644 source/includes/tcp/_cmd_pair_SRC.md create mode 100644 source/includes/tcp/_cmd_query_status.md create mode 100644 source/includes/tcp/_cmd_system.md create mode 100644 source/includes/tcp/_cmd_volume.md diff --git a/source/includes/tcp/_cmd_pair_SRC.md b/source/includes/tcp/_cmd_pair_SRC.md new file mode 100644 index 0000000..ccef000 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_SRC.md @@ -0,0 +1,51 @@ +### Device Status Command Pair `SRC` + +These commands share a common parameter table + +Parameter | Description +---|--- +`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 + +### Get Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC&: +``` + +> Example Response: + +```plaintext +MCU+PAS+SRC:NET& +``` + +This request will return the current audio source + +Command: `MCU+PAS+RAKOIT:SRC&` + +Response: `MCU+PAS+RAKOIT:SRC{str_player_mode}&` + + +### Select Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC:&: +``` + +> Example Response: + +```plaintext +NET = AXX+MEA+RDY AXX+PLY+000 +USB = AXX+MEA+RDY AXX+MEA+RDY AXX+PLY+PLA AXX+PLY+000 AXX+PLY+001 +``` + +Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. + +Command: `MCU+PAS+RAKOIT:SRC:` + +Response | Description +---|--- +`AXX+MEA+RDY AXX+PLY+000` | Example reply +`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ +`MCU+PAS+ERR:SRC&` | Check with FZ \ No newline at end of file diff --git a/source/includes/tcp/_cmd_query_status.md b/source/includes/tcp/_cmd_query_status.md new file mode 100644 index 0000000..ca4cde3 --- /dev/null +++ b/source/includes/tcp/_cmd_query_status.md @@ -0,0 +1,33 @@ +### Get the Current Device Status +> Request format: + +```html +"MCU+PAS+RAKOIT:STA&" +``` + +> Example Response: + +```plaintext +MCU+PAS+STA:NET,0,60,0,0,0,1,1,1,0& +``` + +This command provides useful device status information. + +Command: `MCU+PAS+RAKOIT:STA&` + +Response: `MCU+PAS+STA:{str_source},{bool_mute},{int_volume},{int_treble},{int_bass},{bool_net},{bool_internet},{bool_playing},{bool_led},{bool_upgrading}` + +### Description of response values + +Key | Value Description +---|--- +`str_source` | Playback mode
`0` - `PLAYER_MODE_NONE` +`int_volume` | Current volume
The integer range is from `0 - 100`. So can be considered a linear percentage (`0% to 100%`) +`int_treble` | Current treble level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` +`int_bass` | Current bass level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` +`bool_net` | A boolean value indicating current device local network status
'0' Not on local network
`1` Device on local network. +`bool_internet` | A boolean value indicating current device internet connection status
'0' No internet connection
`1` Internet connection active +`bool_playing` | A boolean value indicating if playback is active
'0' Playback not active
`1` Playback active +`bool_led` | A boolean value indicating if main LED light is enabled or disabled
'0' LED disabled
`1` LED enabled +`bool_upgrading` | A boolean value indicating if a device firmware upgrade is in progress
'0' No firmware upgrade in progress
`1` upgrading firmware + diff --git a/source/includes/tcp/_cmd_system.md b/source/includes/tcp/_cmd_system.md new file mode 100644 index 0000000..0a018fd --- /dev/null +++ b/source/includes/tcp/_cmd_system.md @@ -0,0 +1,57 @@ +### SYSTEM COMMANDS + +The following commands are all "system" commands 'SYS' + +Command: `MCU+PAS+RAKOIT:SYS:` + +### Factory Reset +> Request format: + +```html +"MCU+PAS+RAKOIT:SYS:RESET&" +``` + +> Example Response: + +```plaintext +PLY+000 AXX+PMT+000 AXX+FACTORY AXX+DEV+RST +``` + +This will stop playback and reset the device to factory settings. + +Command: `MCU+PAS+RAKOIT:SYS:RESET&` + +The response string will confirm that the command has been accepted +`PLY+000 AXX+PMT+000 AXX+FACTORY AXX+DEV+RST` + +### System Reboot +> Request format: + +```html +"MCU+PAS+RAKOIT:SYS:REBOOT&" +``` + +> No Response: + +This will stop playback immediately and will reboot the device. Playback is resumed after reboot has been completed. + +Command: `MCU+PAS+RAKOIT:SYS:REBOOT&` + +This command will reboot the whole device including the base board and the wifi module. + + +### System Standby +> Request format: + +```html +"MCU+PAS+RAKOIT:SYS:STANDBY&" +``` + +> No Response: + +This will stop playback immediately and power off the device. + +Command: `MCU+PAS+RAKOIT:SYS:STANDBY&` + + + diff --git a/source/includes/tcp/_cmd_volume.md b/source/includes/tcp/_cmd_volume.md new file mode 100644 index 0000000..e7c1ca3 --- /dev/null +++ b/source/includes/tcp/_cmd_volume.md @@ -0,0 +1,59 @@ +### Request Volume Level +> Request format: + +```html +"MCU+PAS+RAKOIT:VOL&: +``` + +> Example Response: + +```plaintext +AXX+VOL+23 +``` + +Requests the Current Volume. + +Command: `MCU+PAS+RAKOIT:SRC:` + +The Value returned is an Integer + + +### Set Volume Level +> Request format for command: + +```html +MCU+PAS+RAKOIT:VOL:& +``` + +> There is No Response to this command: + +Set the required volume level `0-100` + +Command: `MCU+PAS+RAKOIT:PST:` + +Parameter | Description +---|---|--- +`int_volume` | Integer value for the required Volume
Value range is from `0 - 100` + + +### Mute Device +> Request format: + +```html +"MCU+PAS+RAKOIT:MUT:1& or MCU+PAS+RAKOIT:MUT:0& or MCU+PAS+RAKOIT:MUT:T&" +``` + +> Example Response: + +```plaintext +MCU+PAS+MUT:0& +MCU+PAS+MUT:1& +``` + +Mute and Unmute device. + +Command: `MCU+PAS+RAKOIT:MUT:&` + +Parameter | Description +---|---|--- +`bool_or_toggle` | A boolean value or the charater `T`
`1` mute
`0` unmute
'T' Toggle between mute and unmute diff --git a/source/includes/tcp/_intro_welcome.md b/source/includes/tcp/_intro_welcome.md index 855f1fa..4ce64fa 100644 --- a/source/includes/tcp/_intro_welcome.md +++ b/source/includes/tcp/_intro_welcome.md @@ -1,3 +1,11 @@ # TCP API Welcome to Arylic's TCP API developer documentation. + +MCU+PAS+RAKOIT:{message:param}& + +All commands are terminated with the special character `&` + +Some Commands are Command Pairs where the same 3 character code `ABC` can be used for query/read or control/write + `MCU+PAS+RAKOIT:ABC&` - Query or Read Values + `MCU+PAS+RAKOIT:ABC:{parameter}&` - Control Functions or Write Values \ No newline at end of file From 02c342fe3cffcb04a5b7544759eb0091f6501b08 Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Wed, 13 Oct 2021 12:19:13 +0100 Subject: [PATCH 4/7] Session Back Up Not Tested or Finished --- source/includes/tcp/_cmd_pair_BAS.md | 51 ++++++++++++++++++++++++ source/includes/tcp/_cmd_pair_BEP.md | 46 +++++++++++++++++++++ source/includes/tcp/_cmd_pair_LED.md | 42 +++++++++++++++++++ source/includes/tcp/_cmd_pair_SRC.md | 6 +-- source/includes/tcp/_cmd_pair_TRE.md | 51 ++++++++++++++++++++++++ source/includes/tcp/_cmd_pair_VOL.md | 38 ++++++++++++++++++ source/includes/tcp/_cmd_playback.md | 22 ---------- source/includes/tcp/_cmd_query_status.md | 10 ++--- source/includes/tcp/_cmd_system.md | 9 ++--- source/includes/tcp/_group_playback.md | 1 + source/includes/tcp/_group_system.md | 1 + source/includes/tcp/_intro_welcome.md | 23 ++++++++++- source/includes/tcp/notes.txt | 2 + source/tcp-index.md | 18 +++++++++ 14 files changed, 282 insertions(+), 38 deletions(-) create mode 100644 source/includes/tcp/_cmd_pair_BAS.md create mode 100644 source/includes/tcp/_cmd_pair_BEP.md create mode 100644 source/includes/tcp/_cmd_pair_LED.md create mode 100644 source/includes/tcp/_cmd_pair_TRE.md create mode 100644 source/includes/tcp/_cmd_pair_VOL.md create mode 100644 source/includes/tcp/_group_playback.md create mode 100644 source/includes/tcp/_group_system.md create mode 100644 source/includes/tcp/notes.txt diff --git a/source/includes/tcp/_cmd_pair_BAS.md b/source/includes/tcp/_cmd_pair_BAS.md new file mode 100644 index 0000000..fdc9003 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_BAS.md @@ -0,0 +1,51 @@ +# Device Status Command Pair `SRC` + +These commands share a common parameter table + +Parameter | Description +---|--- +`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 + +### Get Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC&: +``` + +> Example Response: + +```plaintext +MCU+PAS+SRC:NET& +``` + +This request will return the current audio source + +Command: `MCU+PAS+RAKOIT:SRC&` + +Response: `MCU+PAS+RAKOIT:SRC{str_player_mode}&` + + +### Select Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC:&:" +``` + +> Example Response: + +```plaintext +NET = AXX+MEA+RDY AXX+PLY+000 +USB = AXX+MEA+RDY AXX+MEA+RDY AXX+PLY+PLA AXX+PLY+000 AXX+PLY+001 +``` + +Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. + +Command: `MCU+PAS+RAKOIT:SRC:` + +Response | Description +---|--- +`AXX+MEA+RDY AXX+PLY+000` | Example reply +`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ +`MCU+PAS+ERR:SRC&` | Check with FZ \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_BEP.md b/source/includes/tcp/_cmd_pair_BEP.md new file mode 100644 index 0000000..d5ee197 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_BEP.md @@ -0,0 +1,46 @@ +## Device Main BEEP Tone (Enable/Disable) Command Pair `BEP` + +### Get BEEP Tone Status (Enabled/Disbled) +> Get Request format: + +```html +MCU+PAS+RAKOIT:BEP&: +``` + +> Example Response: + +```plaintext +MCU+PAS+BEP:0& or MCU+PAS+BEP:1& +``` +This request will return a boolean state of the BEEP Tone Enable/Disable Function + +Command: `MCU+PAS+RAKOIT:BEP&` + +Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone Enabled + + + + +### Set BEEP Tone Status (Enabled/Disbled) +> Set Request format: + +```html +MCU+PAS+RAKOIT:BEP:1& or MCU+PAS+RAKOIT:BEP:0& or MCU+PAS+RAKOIT:BEP:T& +``` + +> Example Response: + +```plaintext +MCU+PAS+BEP:0& +MCU+PAS+BEP:1& +``` + +Enables & Disables device main BEEP Tone. + +Command: `MCU+PAS+RAKOIT:BEP:&` + +Parameter | Description +---|---|--- +`bool_or_toggle` | A boolean value or the charater `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable + +Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone Enabled diff --git a/source/includes/tcp/_cmd_pair_LED.md b/source/includes/tcp/_cmd_pair_LED.md new file mode 100644 index 0000000..74c2e11 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_LED.md @@ -0,0 +1,42 @@ +## Device Main LED (Enable/Disable) Command Pair `LED` +### Get LED Status (Enabled/Disbled) +> Get Request format: + +```html +MCU+PAS+RAKOIT:LED&: +``` + +> Example Response: + +```plaintext +MCU+PAS+LED:0& or MCU+PAS+LED:1& +``` +This request will return a boolean state of the LED Enable/Disable Function + +Command: `MCU+PAS+RAKOIT:LED&` + +Response:
`MCU+PAS+LED:0&` LED Disabled
`MCU+PAS+LED:1&` LED Enabled
+ +### Set LED Status (Enabled/Disbled) +> Set Request format: + +```html +MCU+PAS+RAKOIT:LED:1& or MCU+PAS+RAKOIT:LED:0& or MCU+PAS+RAKOIT:LED:T& +``` + +> Example Response: + +```plaintext +MCU+PAS+LED:0& +MCU+PAS+LED:1& +``` + +Enables & Disables device main LED. + +Command: `MCU+PAS+RAKOIT:LED:&` + +Parameter | Description +---|---|--- +`bool_or_toggle` | A boolean value or the charater `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable + +Response:
`MCU+PAS+LED:0&` LED Disabled
`MCU+PAS+LED:1&` LED Enabled diff --git a/source/includes/tcp/_cmd_pair_SRC.md b/source/includes/tcp/_cmd_pair_SRC.md index ccef000..9a9ce0d 100644 --- a/source/includes/tcp/_cmd_pair_SRC.md +++ b/source/includes/tcp/_cmd_pair_SRC.md @@ -1,4 +1,4 @@ -### Device Status Command Pair `SRC` +## Device Status Command Pair `SRC` These commands share a common parameter table @@ -23,14 +23,14 @@ This request will return the current audio source Command: `MCU+PAS+RAKOIT:SRC&` -Response: `MCU+PAS+RAKOIT:SRC{str_player_mode}&` +Response: `MCU+PAS+RAKOIT:SRC&` ### Select Device Audio Source > Request format: ```html -"MCU+PAS+RAKOIT:SRC:&: +MCU+PAS+RAKOIT:SRC:``&: ``` > Example Response: diff --git a/source/includes/tcp/_cmd_pair_TRE.md b/source/includes/tcp/_cmd_pair_TRE.md new file mode 100644 index 0000000..fdc9003 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_TRE.md @@ -0,0 +1,51 @@ +# Device Status Command Pair `SRC` + +These commands share a common parameter table + +Parameter | Description +---|--- +`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 + +### Get Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC&: +``` + +> Example Response: + +```plaintext +MCU+PAS+SRC:NET& +``` + +This request will return the current audio source + +Command: `MCU+PAS+RAKOIT:SRC&` + +Response: `MCU+PAS+RAKOIT:SRC{str_player_mode}&` + + +### Select Device Audio Source +> Request format: + +```html +"MCU+PAS+RAKOIT:SRC:&:" +``` + +> Example Response: + +```plaintext +NET = AXX+MEA+RDY AXX+PLY+000 +USB = AXX+MEA+RDY AXX+MEA+RDY AXX+PLY+PLA AXX+PLY+000 AXX+PLY+001 +``` + +Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. + +Command: `MCU+PAS+RAKOIT:SRC:` + +Response | Description +---|--- +`AXX+MEA+RDY AXX+PLY+000` | Example reply +`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ +`MCU+PAS+ERR:SRC&` | Check with FZ \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_VOL.md b/source/includes/tcp/_cmd_pair_VOL.md new file mode 100644 index 0000000..78e5478 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_VOL.md @@ -0,0 +1,38 @@ +## Device Volume Command Pair + +### Get Device Volume +> Get command format: + +```html +"MCU+PAS+RAKOIT:VOL&: +``` + +> Example Response: + +```plaintext +MCU+PAS+VOL:``& +``` + +This request will return the current device volume level + +Command: `MCU+PAS+RAKOIT:VOL&` + +Response: `MCU+PAS+RAKOIT:VOL&` + `` Integer value of the volume level. Value range is from `0 - 100`
+ + +### Select Device Volume +> Set command format: + +```html +MCU+PAS+RAKOIT:VOL``&: + +There is no Response for this command: +``` + +Sets the Volume of the Device. + +Command: `MCU+PAS+RAKOIT:VOL&` + `` Integer value of the volume level. Value range is from `0 - 100`
+ +Response There is no response for this command. \ No newline at end of file diff --git a/source/includes/tcp/_cmd_playback.md b/source/includes/tcp/_cmd_playback.md index 8845854..2391933 100644 --- a/source/includes/tcp/_cmd_playback.md +++ b/source/includes/tcp/_cmd_playback.md @@ -1,25 +1,3 @@ -### Device Audio Source -> Request format: - -```html -"MCU+PAS+RAKOIT:SRC:&: -``` - -> Example Response: - -```plaintext -OK -``` - -Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. - -Command: `MCU+PAS+RAKOIT:SRC:` - -Parameter | Description ----|--- -`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 - - ### Play Preset Content > Request format for command: diff --git a/source/includes/tcp/_cmd_query_status.md b/source/includes/tcp/_cmd_query_status.md index ca4cde3..9e3d017 100644 --- a/source/includes/tcp/_cmd_query_status.md +++ b/source/includes/tcp/_cmd_query_status.md @@ -25,9 +25,9 @@ Key | Value Description `int_volume` | Current volume
The integer range is from `0 - 100`. So can be considered a linear percentage (`0% to 100%`) `int_treble` | Current treble level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` `int_bass` | Current bass level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` -`bool_net` | A boolean value indicating current device local network status
'0' Not on local network
`1` Device on local network. -`bool_internet` | A boolean value indicating current device internet connection status
'0' No internet connection
`1` Internet connection active -`bool_playing` | A boolean value indicating if playback is active
'0' Playback not active
`1` Playback active -`bool_led` | A boolean value indicating if main LED light is enabled or disabled
'0' LED disabled
`1` LED enabled -`bool_upgrading` | A boolean value indicating if a device firmware upgrade is in progress
'0' No firmware upgrade in progress
`1` upgrading firmware +`bool_net` | A boolean value indicating current device local network status
`0` Not on local network
`1` Device on local network. +`bool_internet` | A boolean value indicating current device internet connection status
`0` No internet connection
`1` Internet connection active +`bool_playing` | A boolean value indicating if playback is active
`0` Playback not active
`1` Playback active +`bool_led` | A boolean value indicating if main LED light is enabled or disabled
`0` LED disabled
`1` LED enabled +`bool_upgrading` | A boolean value indicating if a device firmware upgrade is in progress
`0` No firmware upgrade in progress
`1` upgrading firmware diff --git a/source/includes/tcp/_cmd_system.md b/source/includes/tcp/_cmd_system.md index 0a018fd..e899a21 100644 --- a/source/includes/tcp/_cmd_system.md +++ b/source/includes/tcp/_cmd_system.md @@ -1,16 +1,13 @@ -### SYSTEM COMMANDS +# SYSTEM COMMANDS The following commands are all "system" commands 'SYS' Command: `MCU+PAS+RAKOIT:SYS:` ### Factory Reset -> Request format: - -```html -"MCU+PAS+RAKOIT:SYS:RESET&" +> Request format: ```html +MCU+PAS+RAKOIT:SYS:RESET& ``` - > Example Response: ```plaintext diff --git a/source/includes/tcp/_group_playback.md b/source/includes/tcp/_group_playback.md new file mode 100644 index 0000000..a54281f --- /dev/null +++ b/source/includes/tcp/_group_playback.md @@ -0,0 +1 @@ +# Playback Control diff --git a/source/includes/tcp/_group_system.md b/source/includes/tcp/_group_system.md new file mode 100644 index 0000000..fa092b6 --- /dev/null +++ b/source/includes/tcp/_group_system.md @@ -0,0 +1 @@ +# System Commands diff --git a/source/includes/tcp/_intro_welcome.md b/source/includes/tcp/_intro_welcome.md index 4ce64fa..6405df1 100644 --- a/source/includes/tcp/_intro_welcome.md +++ b/source/includes/tcp/_intro_welcome.md @@ -2,10 +2,29 @@ Welcome to Arylic's TCP API developer documentation. -MCU+PAS+RAKOIT:{message:param}& +The Query and Control Interface is supported by standard TCP/IP Sockets. So unique socket identification on the LAN/WLAN is the pair of the Arylic Device IP Address and the Communication Port. The creation and management of TCP/IP Sockets is no covered in the Scope of this document as this can found in many places on the Internet and in books. + +It is a strong recommendation to familise yourself with the Arylic "Web Management Interface". This will enable you to configure the IP address of your Arylic Device and also configure the communications Port for the TCP/IP Socket if required. + +Arylic provide a simple development Tool for Windows. + +The "root" of these commands is
`MCU+PAS+RAKOIT:` All commands are terminated with the special character `&` Some Commands are Command Pairs where the same 3 character code `ABC` can be used for query/read or control/write `MCU+PAS+RAKOIT:ABC&` - Query or Read Values - `MCU+PAS+RAKOIT:ABC:{parameter}&` - Control Functions or Write Values \ No newline at end of file + `MCU+PAS+RAKOIT:ABC:{parameter}&` - Control Functions or Write Values + +The Command Pairs (Read & Write) are the following:- + + Playback related commands: + SRC - Device Source + VOL - Device Volume + TRE - Equaliser Treble Level + BAS - Equaliser Bass Level + VBS - Virtual Bass + + Hardware configuration commands: + LED - Main Device LED + BEP - Device Beep \ No newline at end of file diff --git a/source/includes/tcp/notes.txt b/source/includes/tcp/notes.txt new file mode 100644 index 0000000..dca0472 --- /dev/null +++ b/source/includes/tcp/notes.txt @@ -0,0 +1,2 @@ +KPW Notes - October 2021 + diff --git a/source/tcp-index.md b/source/tcp-index.md index 6ab0062..c808ccf 100644 --- a/source/tcp-index.md +++ b/source/tcp-index.md @@ -10,6 +10,24 @@ toc_footers: includes: - tcp/intro_welcome + # SYSTEM COMMANDS + - tcp/cmd_system + + # DEVICE STATUS & SOURCES + - tcp/cmd_query_status + - tcp/cmd_pair_SRC + + # PLAYBACK CONTROL + - tcp/cmd_playback + - tcp/cmd_pair_VOL + - tcp/cmd_pair_TRE + - tcp/cmd_pair_BAS + + # HARDWARE COMMANDS + - tcp/cmd_pair_LED + - tcp/cmd_pair_BEP + + search: true code_clipboard: false From 4a88b8258c21e9f251ae461a57f7745596475d0c Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Fri, 15 Oct 2021 12:33:33 +0100 Subject: [PATCH 5/7] session back up untested and not finished --- source/includes/tcp/_cmd_network.md | 58 ++++++++++++++++++++++++ source/includes/tcp/_cmd_pair_BEP.md | 4 +- source/includes/tcp/_cmd_pair_LED.md | 2 +- source/includes/tcp/_cmd_pair_LPM.md | 38 ++++++++++++++++ source/includes/tcp/_cmd_pair_NAM.md | 51 +++++++++++++++++++++ source/includes/tcp/_cmd_pair_TRE.md | 2 +- source/includes/tcp/_cmd_pair_VBS.md | 42 +++++++++++++++++ source/includes/tcp/_cmd_query_status.md | 4 ++ source/includes/tcp/_cmd_system.md | 16 +++++-- source/includes/tcp/_intro_welcome.md | 7 ++- source/tcp-index.md | 15 ++++-- 11 files changed, 226 insertions(+), 13 deletions(-) create mode 100644 source/includes/tcp/_cmd_network.md create mode 100644 source/includes/tcp/_cmd_pair_LPM.md create mode 100644 source/includes/tcp/_cmd_pair_NAM.md create mode 100644 source/includes/tcp/_cmd_pair_VBS.md diff --git a/source/includes/tcp/_cmd_network.md b/source/includes/tcp/_cmd_network.md new file mode 100644 index 0000000..7be38a0 --- /dev/null +++ b/source/includes/tcp/_cmd_network.md @@ -0,0 +1,58 @@ +## Network Information Commands + +### Get Status of Ethernet Connection (RJ45 Network) +> Get command format: + +```html +MCU+PAS+RAKOIT:ETH&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:ETH:0& or MCU+PAS+RAKOIT:ETH:1& +``` +This command will return the status of the device on the Local Area Network (LAN). + +Command: `MCU+PAS+RAKOIT:ETH&` + +Response:
`MCU+PAS+RAKOIT:ETH:0&` Device not connected to LAN
`MCU+PAS+RAKOIT:ETH:1&` Device connected to LAN

+ + + +### Get Status of Wireless Connection (WiFi Network) +> Get command format: + +```html +MCU+PAS+RAKOIT:WIF&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:WIF:0& or MCU+PAS+RAKOIT:WIF:1& +``` +This command will return the status of the device on the Wireless Local Area Network (WLAN). + +Command: `MCU+PAS+RAKOIT:ETH&` + +Response:
`MCU+PAS+RAKOIT:WIF:0&` Device not connected to WLAN
`MCU+PAS+RAKOIT:WIF:1&` Device connected to WLAN
+ + +### Get Status of Internet Connection +> Get command format: + +```html +MCU+PAS+RAKOIT:WWW&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:WWW:0& or MCU+PAS+RAKOIT:WWW:1& +``` +This command will return the status of the device Internet Connection. + +Command: `MCU+PAS+RAKOIT:WWW&` + +Response:
`MCU+PAS+RAKOIT:WWW:0&` Device not connected to Internet
`MCU+PAS+RAKOIT:WIF:1&` Device connected to Internet
\ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_BEP.md b/source/includes/tcp/_cmd_pair_BEP.md index d5ee197..4e3d343 100644 --- a/source/includes/tcp/_cmd_pair_BEP.md +++ b/source/includes/tcp/_cmd_pair_BEP.md @@ -25,7 +25,7 @@ Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone > Set Request format: ```html -MCU+PAS+RAKOIT:BEP:1& or MCU+PAS+RAKOIT:BEP:0& or MCU+PAS+RAKOIT:BEP:T& +MCU+PAS+RAKOIT:BEP:1& or MCU+PAS+RAKOIT:BEP:0& ``` > Example Response: @@ -41,6 +41,6 @@ Command: `MCU+PAS+RAKOIT:BEP:&` Parameter | Description ---|---|--- -`bool_or_toggle` | A boolean value or the charater `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable +`bool_or_toggle` | A boolean value
`1` Disable
`0` Enable
Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone Enabled diff --git a/source/includes/tcp/_cmd_pair_LED.md b/source/includes/tcp/_cmd_pair_LED.md index 74c2e11..b01b8a9 100644 --- a/source/includes/tcp/_cmd_pair_LED.md +++ b/source/includes/tcp/_cmd_pair_LED.md @@ -37,6 +37,6 @@ Command: `MCU+PAS+RAKOIT:LED:&` Parameter | Description ---|---|--- -`bool_or_toggle` | A boolean value or the charater `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable +`bool_or_toggle` | A boolean value or the character `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable Response:
`MCU+PAS+LED:0&` LED Disabled
`MCU+PAS+LED:1&` LED Enabled diff --git a/source/includes/tcp/_cmd_pair_LPM.md b/source/includes/tcp/_cmd_pair_LPM.md new file mode 100644 index 0000000..78e5478 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_LPM.md @@ -0,0 +1,38 @@ +## Device Volume Command Pair + +### Get Device Volume +> Get command format: + +```html +"MCU+PAS+RAKOIT:VOL&: +``` + +> Example Response: + +```plaintext +MCU+PAS+VOL:``& +``` + +This request will return the current device volume level + +Command: `MCU+PAS+RAKOIT:VOL&` + +Response: `MCU+PAS+RAKOIT:VOL&` + `` Integer value of the volume level. Value range is from `0 - 100`
+ + +### Select Device Volume +> Set command format: + +```html +MCU+PAS+RAKOIT:VOL``&: + +There is no Response for this command: +``` + +Sets the Volume of the Device. + +Command: `MCU+PAS+RAKOIT:VOL&` + `` Integer value of the volume level. Value range is from `0 - 100`
+ +Response There is no response for this command. \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_NAM.md b/source/includes/tcp/_cmd_pair_NAM.md new file mode 100644 index 0000000..08a18a3 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_NAM.md @@ -0,0 +1,51 @@ +## Device Name (Command Pair Get & Set) + +### Get Device Name +> Get command format: + +```html +MCU+PAS+RAKOIT:NAM&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:NAM:4E4F42425920424F58& +``` +This command will return the current device name. + +Command: `MCU+PAS+RAKOIT:NAM&` + +Response: Is a hexadecimal string + + + +### Set Device Name +> Set command format: + +```html +MCU+PAS+RAKOIT:NAM:& +``` + +> Example Response: + +```plaintext +AXX+NAM+RAKOIT:& +``` + +Sets the device name. + +Command: `MCU+PAS+RAKOIT:NAM:&` + +Parameter | Description +---|---|--- +`hex_str_name` | Device name string (hexadecimal) +`ascii_str_name` | Device name string (ascii characeters) + +Response:
`MCU+PAS+RAKOIT:&` + + \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_TRE.md b/source/includes/tcp/_cmd_pair_TRE.md index fdc9003..b2d098d 100644 --- a/source/includes/tcp/_cmd_pair_TRE.md +++ b/source/includes/tcp/_cmd_pair_TRE.md @@ -1,4 +1,4 @@ -# Device Status Command Pair `SRC` +## Device Status Command Pair `SRC` These commands share a common parameter table diff --git a/source/includes/tcp/_cmd_pair_VBS.md b/source/includes/tcp/_cmd_pair_VBS.md new file mode 100644 index 0000000..9622500 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_VBS.md @@ -0,0 +1,42 @@ +## Device Virtual Bass (Enable/Disable) Command Pair `VBS` +### Get Virtual Bass Status (Enabled/Disbled) +> Get Request format: + +```html +MCU+PAS+RAKOIT:VBS&: +``` + +> Example Response: + +```plaintext +MCU+PAS+VBS:0& or MCU+PAS+VBS:1& +``` +This request will return a boolean state of the Virtual Bass Enable/Disable Function + +Command: `MCU+PAS+RAKOIT:VBS&` + +Response:
`MCU+PAS+VBS:0&` Virtual Bass Disabled
`MCU+PAS+VBS:1&` Virtual Bass Enabled
+ +### Set Virtual Bass Status (Enabled/Disbled) +> Set Request format: + +```html +MCU+PAS+RAKOIT:VBS:1& or MCU+PAS+RAKOIT:VBS:0& or MCU+PAS+RAKOIT:VBS:T& +``` + +> Example Response: + +```plaintext +MCU+PAS+VBS:0& +MCU+PAS+VBS:1& +``` + +Enables & Disables device Virtual Bass. + +Command: `MCU+PAS+RAKOIT:VBS:&` + +Parameter | Description +---|---|--- +`bool_or_toggle` | A boolean value or the character `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable + +Response:
`MCU+PAS+VBS:0&` Virtual Bass Disabled
`MCU+PAS+VBS:1&` Virtual Bass Enabled \ No newline at end of file diff --git a/source/includes/tcp/_cmd_query_status.md b/source/includes/tcp/_cmd_query_status.md index 9e3d017..0e6993f 100644 --- a/source/includes/tcp/_cmd_query_status.md +++ b/source/includes/tcp/_cmd_query_status.md @@ -22,6 +22,7 @@ Response: `MCU+PAS+STA:{str_source},{bool_mute},{int_volume},{int_treble},{int_b Key | Value Description ---|--- `str_source` | Playback mode
`0` - `PLAYER_MODE_NONE` +`bool_mute` | A boolean value indicating if mute is active
`0` mute not active
`1` mute active. `int_volume` | Current volume
The integer range is from `0 - 100`. So can be considered a linear percentage (`0% to 100%`) `int_treble` | Current treble level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` `int_bass` | Current bass level
The integer range is from `-10 - 10`. This corresponds to `-10dB` & `+10dB` @@ -31,3 +32,6 @@ Key | Value Description `bool_led` | A boolean value indicating if main LED light is enabled or disabled
`0` LED disabled
`1` LED enabled `bool_upgrading` | A boolean value indicating if a device firmware upgrade is in progress
`0` No firmware upgrade in progress
`1` upgrading firmware + \ No newline at end of file diff --git a/source/includes/tcp/_cmd_system.md b/source/includes/tcp/_cmd_system.md index e899a21..25a21d5 100644 --- a/source/includes/tcp/_cmd_system.md +++ b/source/includes/tcp/_cmd_system.md @@ -21,11 +21,14 @@ Command: `MCU+PAS+RAKOIT:SYS:RESET&` The response string will confirm that the command has been accepted `PLY+000 AXX+PMT+000 AXX+FACTORY AXX+DEV+RST` -### System Reboot -> Request format: + +### System Reboot +> Request format: ```html -"MCU+PAS+RAKOIT:SYS:REBOOT&" +MCU+PAS+RAKOIT:SYS:REBOOT& ``` > No Response: @@ -36,6 +39,9 @@ Command: `MCU+PAS+RAKOIT:SYS:REBOOT&` This command will reboot the whole device including the base board and the wifi module. + ### System Standby > Request format: @@ -50,5 +56,9 @@ This will stop playback immediately and power off the device. Command: `MCU+PAS+RAKOIT:SYS:STANDBY&` + + diff --git a/source/includes/tcp/_intro_welcome.md b/source/includes/tcp/_intro_welcome.md index 6405df1..30553b5 100644 --- a/source/includes/tcp/_intro_welcome.md +++ b/source/includes/tcp/_intro_welcome.md @@ -24,7 +24,12 @@ The Command Pairs (Read & Write) are the following:- TRE - Equaliser Treble Level BAS - Equaliser Bass Level VBS - Virtual Bass + LPM - Loop and Repeat Modes Hardware configuration commands: + NAM - Device Name LED - Main Device LED - BEP - Device Beep \ No newline at end of file + BEP - Device Beep + + Coonection configuration commands: + BTC - BT connection blah blah \ No newline at end of file diff --git a/source/tcp-index.md b/source/tcp-index.md index c808ccf..ffcf4ed 100644 --- a/source/tcp-index.md +++ b/source/tcp-index.md @@ -13,6 +13,14 @@ includes: # SYSTEM COMMANDS - tcp/cmd_system + # HARDWARE/DEVICE COMMANDS + - tcp/cmd_pair_NAM + - tcp/cmd_pair_LED + - tcp/cmd_pair_BEP + + # NETWORK COMMANDS + - tcp/cmd_network + # DEVICE STATUS & SOURCES - tcp/cmd_query_status - tcp/cmd_pair_SRC @@ -22,11 +30,8 @@ includes: - tcp/cmd_pair_VOL - tcp/cmd_pair_TRE - tcp/cmd_pair_BAS - - # HARDWARE COMMANDS - - tcp/cmd_pair_LED - - tcp/cmd_pair_BEP - + - tcp/cmd_pair_VBS + - tcp/cmd_pair_LPM search: true From 1df5205245bd040e6ea589b42f1fe77952a5f994 Mon Sep 17 00:00:00 2001 From: Frank Gregor Date: Fri, 15 Oct 2021 19:18:42 +0200 Subject: [PATCH 6/7] Fix some Markdown formatting --- source/includes/tcp/_cmd_pair_LED.md | 40 ++++++++------- source/includes/tcp/_cmd_pair_NAM.md | 21 ++++---- source/includes/tcp/_cmd_system.md | 32 ++++++------ source/includes/tcp/_intro_welcome.md | 48 ++++++++++-------- source/index.html.md | 71 ++++++++++----------------- 5 files changed, 101 insertions(+), 111 deletions(-) diff --git a/source/includes/tcp/_cmd_pair_LED.md b/source/includes/tcp/_cmd_pair_LED.md index b01b8a9..50810bf 100644 --- a/source/includes/tcp/_cmd_pair_LED.md +++ b/source/includes/tcp/_cmd_pair_LED.md @@ -1,42 +1,44 @@ -## Device Main LED (Enable/Disable) Command Pair `LED` -### Get LED Status (Enabled/Disbled) -> Get Request format: +## Device Main LED +### Get LED Status -```html +> Command: + +```plaintext MCU+PAS+RAKOIT:LED&: ``` > Example Response: ```plaintext -MCU+PAS+LED:0& or MCU+PAS+LED:1& +MCU+PAS+LED:0& // LED Disabled +MCU+PAS+LED:1& // LED Enabled ``` -This request will return a boolean state of the LED Enable/Disable Function -Command: `MCU+PAS+RAKOIT:LED&` +This command will return a boolean state of the LED Enable/Disable Function. + +






-Response:
`MCU+PAS+LED:0&` LED Disabled
`MCU+PAS+LED:1&` LED Enabled
+### Set LED Status -### Set LED Status (Enabled/Disbled) -> Set Request format: +> Command: -```html -MCU+PAS+RAKOIT:LED:1& or MCU+PAS+RAKOIT:LED:0& or MCU+PAS+RAKOIT:LED:T& +```plaintext +MCU+PAS+RAKOIT:LED:0& // Disable LED +MCU+PAS+RAKOIT:LED:1& // Enable LED +MCU+PAS+RAKOIT:LED:T& // Toggle current LED status ``` > Example Response: ```plaintext -MCU+PAS+LED:0& -MCU+PAS+LED:1& +MCU+PAS+LED:0& // LED Disabled +MCU+PAS+LED:1& // LED Enabled ``` Enables & Disables device main LED. -Command: `MCU+PAS+RAKOIT:LED:&` - Parameter | Description ---|---|--- -`bool_or_toggle` | A boolean value or the character `T`
`1` Disable
`0` Enable
`T` Toggle between enable & disable - -Response:
`MCU+PAS+LED:0&` LED Disabled
`MCU+PAS+LED:1&` LED Enabled +`0` | Disable +`1` | Enable +`T` | Toggle current LED status diff --git a/source/includes/tcp/_cmd_pair_NAM.md b/source/includes/tcp/_cmd_pair_NAM.md index 08a18a3..fe55030 100644 --- a/source/includes/tcp/_cmd_pair_NAM.md +++ b/source/includes/tcp/_cmd_pair_NAM.md @@ -1,9 +1,10 @@ -## Device Name (Command Pair Get & Set) +## Device Name ### Get Device Name -> Get command format: -```html +> Command: + +```plaintext MCU+PAS+RAKOIT:NAM&: ``` @@ -12,20 +13,22 @@ MCU+PAS+RAKOIT:NAM&: ```plaintext MCU+PAS+RAKOIT:NAM:4E4F42425920424F58& ``` -This command will return the current device name. - -Command: `MCU+PAS+RAKOIT:NAM&` +This command will return the current device name. Response: Is a hexadecimal string +

+



+ ### Set Device Name -> Set command format: -```html +> Command: + +```plaintext MCU+PAS+RAKOIT:NAM:& ``` @@ -37,8 +40,6 @@ AXX+NAM+RAKOIT:& Sets the device name. -Command: `MCU+PAS+RAKOIT:NAM:&` - Parameter | Description ---|---|--- `hex_str_name` | Device name string (hexadecimal) diff --git a/source/includes/tcp/_cmd_system.md b/source/includes/tcp/_cmd_system.md index 25a21d5..65ef1a3 100644 --- a/source/includes/tcp/_cmd_system.md +++ b/source/includes/tcp/_cmd_system.md @@ -5,9 +5,13 @@ The following commands are all "system" commands 'SYS' Command: `MCU+PAS+RAKOIT:SYS:` ### Factory Reset -> Request format: ```html + +> Command: + +```plaintext MCU+PAS+RAKOIT:SYS:RESET& ``` + > Example Response: ```plaintext @@ -15,38 +19,38 @@ PLY+000 AXX+PMT+000 AXX+FACTORY AXX+DEV+RST ``` This will stop playback and reset the device to factory settings. - -Command: `MCU+PAS+RAKOIT:SYS:RESET&` - -The response string will confirm that the command has been accepted -`PLY+000 AXX+PMT+000 AXX+FACTORY AXX+DEV+RST` +The response string will confirm that the command has been accepted. +



+ ### System Reboot -> Request format: -```html + +> Command: + +```plaintext MCU+PAS+RAKOIT:SYS:REBOOT& ``` > No Response: This will stop playback immediately and will reboot the device. Playback is resumed after reboot has been completed. - -Command: `MCU+PAS+RAKOIT:SYS:REBOOT&` - This command will reboot the whole device including the base board and the wifi module. +



+ ### System Standby -> Request format: -```html +> Command: + +```plaintext "MCU+PAS+RAKOIT:SYS:STANDBY&" ``` @@ -54,8 +58,6 @@ If playback is active before reboot, playback and current settings are retained. This will stop playback immediately and power off the device. -Command: `MCU+PAS+RAKOIT:SYS:STANDBY&` - diff --git a/source/includes/tcp/_intro_welcome.md b/source/includes/tcp/_intro_welcome.md index 30553b5..580ab10 100644 --- a/source/includes/tcp/_intro_welcome.md +++ b/source/includes/tcp/_intro_welcome.md @@ -8,28 +8,34 @@ It is a strong recommendation to familise yourself with the Arylic "Web Manageme Arylic provide a simple development Tool for Windows. -The "root" of these commands is
`MCU+PAS+RAKOIT:` +The "root" of these commands is: +`MCU+PAS+RAKOIT:` -All commands are terminated with the special character `&` +All commands are terminated with the special character `&`. -Some Commands are Command Pairs where the same 3 character code `ABC` can be used for query/read or control/write - `MCU+PAS+RAKOIT:ABC&` - Query or Read Values - `MCU+PAS+RAKOIT:ABC:{parameter}&` - Control Functions or Write Values +Some Commands are Command Pairs where the same 3 character code `ABC` can be used for query/read or control/write: -The Command Pairs (Read & Write) are the following:- +* `MCU+PAS+RAKOIT:ABC&` - Query or Read Values +* `MCU+PAS+RAKOIT:ABC:{parameter}&` - Control Functions or Write Values + +The Command Pairs (Read & Write) are the following: - Playback related commands: - SRC - Device Source - VOL - Device Volume - TRE - Equaliser Treble Level - BAS - Equaliser Bass Level - VBS - Virtual Bass - LPM - Loop and Repeat Modes - - Hardware configuration commands: - NAM - Device Name - LED - Main Device LED - BEP - Device Beep - - Coonection configuration commands: - BTC - BT connection blah blah \ No newline at end of file +**Playback related commands:** + + * `SRC` - Device Source + * `VOL` - Device Volume + * `TRE` - Equaliser Treble Level + * `BAS` - Equaliser Bass Level + * `VBS` - Virtual Bass + * `LPM` - Loop and Repeat Modes + +**Hardware configuration commands:** + + * `NAM` - Device Name + * `LED` - Main Device LED + * `BEP` - Device Beep + +**Connection configuration commands:** + + * `BTC` - BT connection blah blah + \ No newline at end of file diff --git a/source/index.html.md b/source/index.html.md index 6906333..ffcf4ed 100644 --- a/source/index.html.md +++ b/source/index.html.md @@ -1,5 +1,5 @@ --- -title: Arylic Audio HTTP API +title: Arylic Audio TCP API Interface # Languages must be one of: https://git.io/vQNgJ language_tabs: @@ -8,51 +8,30 @@ toc_footers: - Made with ❤️ by
Woodbytes and NWT.Stuff includes: - - http/intro_welcome - - http/intro_abstract - - # Networking - - http/group_networking - - http/cmd_networking_wlanGetApListEx - - http/cmd_networking_wlanConnectApEx - - http/cmd_networking_wlanConnectHideApEx - - http/cmd_networking_wlanGetConnectState - - http/cmd_networking_getStaticIP - - http/cmd_networking_setStaticIP - - http/cmd_networking_setDhcp - - # Device Informations - - http/group_device - - http/cmd_device_getStatusEx - - http/cmd_device_getsyslog - - # Playback control - - http/group_playback - - http/cmd_playback - - http/cmd_playback_getPlayerStatus - - http/cmd_playback_setPlayerCmd - - http/cmd_playback_GetTrackNumber - - # USB disk playback - - http/group_usb - - http/cmd_usb_getLocalPlayList - - http/cmd_usb_playLocalList - - http/cmd_usb_getFileInfo - - # Multiroom - - http/group_multiroom - - http/cmd_ConnectMasterAp_JoinGroupMaster - - http/cmd_multiroom - - http/cmd_multiroom_getSlaveList - # - http/cmd_multiroom_SlaveChannel **KPW removed for now doesn't do anything !! - # - http/cmd_multiroom_SlaveMask **KPW removed for now doesn't do anything !! - - http/cmd_multiroom_SlaveMute - # - http/cmd_multiroom_SlaveVolume **KPW removed for now as confusing can be acheieved with other commands !! - - http/cmd_multiroom_SlaveKickout - - http/cmd_multiroom_ungroup - - # Appendix - - http/appendix_hexed_string + - tcp/intro_welcome + + # SYSTEM COMMANDS + - tcp/cmd_system + + # HARDWARE/DEVICE COMMANDS + - tcp/cmd_pair_NAM + - tcp/cmd_pair_LED + - tcp/cmd_pair_BEP + + # NETWORK COMMANDS + - tcp/cmd_network + + # DEVICE STATUS & SOURCES + - tcp/cmd_query_status + - tcp/cmd_pair_SRC + + # PLAYBACK CONTROL + - tcp/cmd_playback + - tcp/cmd_pair_VOL + - tcp/cmd_pair_TRE + - tcp/cmd_pair_BAS + - tcp/cmd_pair_VBS + - tcp/cmd_pair_LPM search: true From 3c086754877b530afcf366f749e7d72cb9f5a885 Mon Sep 17 00:00:00 2001 From: NWT Stuff Date: Wed, 20 Oct 2021 17:42:45 +0100 Subject: [PATCH 7/7] Version 1 - For Review Includes all commands in Frank Zhang spreadsheet with the exception of WRS. Wireless Reset. --- source/includes/tcp/_cmd_CHN.md | 20 ++++++++ source/includes/tcp/_cmd_network.md | 36 +++++++------- source/includes/tcp/_cmd_pair_BAS.md | 52 ++++++++------------ source/includes/tcp/_cmd_pair_BEP.md | 40 +++++++++------- source/includes/tcp/_cmd_pair_BTC.md | 54 +++++++++++++++++++++ source/includes/tcp/_cmd_pair_LED.md | 36 +++++++++----- source/includes/tcp/_cmd_pair_LPM.md | 61 ++++++++++++++++-------- source/includes/tcp/_cmd_pair_NAM.md | 34 ++++++++----- source/includes/tcp/_cmd_pair_SRC.md | 33 +++++++------ source/includes/tcp/_cmd_pair_TRE.md | 52 ++++++++------------ source/includes/tcp/_cmd_pair_VBS.md | 22 +++++---- source/includes/tcp/_cmd_pair_VOL.md | 12 ++--- source/includes/tcp/_cmd_playback.md | 27 ++++++++++- source/includes/tcp/_cmd_query_status.md | 33 ++++++------- source/includes/tcp/_cmd_system.md | 31 +++++++----- source/includes/tcp/_cmd_volume.md | 59 ----------------------- source/includes/tcp/_group_playback.md | 1 - source/includes/tcp/_group_system.md | 1 - source/includes/tcp/notes.txt | 12 +++++ source/tcp-index.md | 4 +- 20 files changed, 356 insertions(+), 264 deletions(-) create mode 100644 source/includes/tcp/_cmd_CHN.md create mode 100644 source/includes/tcp/_cmd_pair_BTC.md delete mode 100644 source/includes/tcp/_cmd_volume.md delete mode 100644 source/includes/tcp/_group_playback.md delete mode 100644 source/includes/tcp/_group_system.md diff --git a/source/includes/tcp/_cmd_CHN.md b/source/includes/tcp/_cmd_CHN.md new file mode 100644 index 0000000..aed2f52 --- /dev/null +++ b/source/includes/tcp/_cmd_CHN.md @@ -0,0 +1,20 @@ +### Get Audio Channel Information (Mono/Stereo) +>Command: + +```plaintext +MCU+PAS+RAKOIT:CHN& +``` + +> Example Response: + +```plaintext +MCU+PAS+CHN:S& or MCU+PAS+CHN:L& or MCU+PAS+CHN:R& +``` +This request will return a string which will indicate stereo active or mono active (including channel left or right) + +Command: `MCU+PAS+RAKOIT:CHN&` + +Response:
+`MCU+PAS+RAKOIT:CHN:S&` Device output is Stereo
+`MCU+PAS+RAKOIT:CHN:L&` Device output is Mono - Left Channel
+`MCU+PAS+RAKOIT:CHN:R&` Device output is Mono - Right Channel
diff --git a/source/includes/tcp/_cmd_network.md b/source/includes/tcp/_cmd_network.md index 7be38a0..acf21d9 100644 --- a/source/includes/tcp/_cmd_network.md +++ b/source/includes/tcp/_cmd_network.md @@ -1,58 +1,60 @@ -## Network Information Commands +# Connection Status Commands ### Get Status of Ethernet Connection (RJ45 Network) -> Get command format: +> Command: -```html +```plaintext MCU+PAS+RAKOIT:ETH&: ``` > Example Response: ```plaintext -MCU+PAS+RAKOIT:ETH:0& or MCU+PAS+RAKOIT:ETH:1& +MCU+PAS+RAKOIT:ETH:0& \\ Device not connected to LAN +MCU+PAS+RAKOIT:ETH:1& \\ Device connected to LAN ``` This command will return the status of the device on the Local Area Network (LAN). Command: `MCU+PAS+RAKOIT:ETH&` -Response:
`MCU+PAS+RAKOIT:ETH:0&` Device not connected to LAN
`MCU+PAS+RAKOIT:ETH:1&` Device connected to LAN

- - +Response:
`MCU+PAS+RAKOIT:ETH:0&` Device not connected to LAN
`MCU+PAS+RAKOIT:ETH:1&` Device connected to LAN +


### Get Status of Wireless Connection (WiFi Network) -> Get command format: +>Command:: -```html +```plaintext MCU+PAS+RAKOIT:WIF&: ``` > Example Response: ```plaintext -MCU+PAS+RAKOIT:WIF:0& or MCU+PAS+RAKOIT:WIF:1& +MCU+PAS+RAKOIT:WIF:0& \\ Device not connected to WLAN +MCU+PAS+RAKOIT:WIF:1& \\ Device connected to WLAN ``` This command will return the status of the device on the Wireless Local Area Network (WLAN). -Command: `MCU+PAS+RAKOIT:ETH&` - -Response:
`MCU+PAS+RAKOIT:WIF:0&` Device not connected to WLAN
`MCU+PAS+RAKOIT:WIF:1&` Device connected to WLAN
+Command: `MCU+PAS+RAKOIT:WIF&` +Response:
`MCU+PAS+RAKOIT:WIF:0&` Device not connected to WLAN
`MCU+PAS+RAKOIT:WIF:1&` Device connected to WLAN +


### Get Status of Internet Connection -> Get command format: +>Command: -```html +```plaintext MCU+PAS+RAKOIT:WWW&: ``` > Example Response: ```plaintext -MCU+PAS+RAKOIT:WWW:0& or MCU+PAS+RAKOIT:WWW:1& +MCU+PAS+RAKOIT:WWW:0& \\ Device not connected to Internet +MCU+PAS+RAKOIT:WWW:1& \\ Device connected to Internet ``` This command will return the status of the device Internet Connection. Command: `MCU+PAS+RAKOIT:WWW&` -Response:
`MCU+PAS+RAKOIT:WWW:0&` Device not connected to Internet
`MCU+PAS+RAKOIT:WIF:1&` Device connected to Internet
\ No newline at end of file +Response:
`MCU+PAS+RAKOIT:WWW:0&` Device not connected to Internet
`MCU+PAS+RAKOIT:WWW:1&` Device connected to Internet
\ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_BAS.md b/source/includes/tcp/_cmd_pair_BAS.md index fdc9003..77b8de5 100644 --- a/source/includes/tcp/_cmd_pair_BAS.md +++ b/source/includes/tcp/_cmd_pair_BAS.md @@ -1,51 +1,37 @@ -# Device Status Command Pair `SRC` +## Device Bass Level - Command Pair +### Get Device Bass Level +>Command: -These commands share a common parameter table - -Parameter | Description ----|--- -`str_player_mode` | The audio source that has to be switched
`NET`: wifi mode
`LINE-IN`: line analogue input
`BT`: bluetooth mode
`OPT`: optical digital input
`???`: RCA Analogue input
`COAX`: co-axial digital input
`LINE-IN2`: line analogue input #2 - -### Get Device Audio Source -> Request format: - -```html -"MCU+PAS+RAKOIT:SRC&: +```plaintext +MCU+PAS+RAKOIT:BAS& ``` > Example Response: ```plaintext -MCU+PAS+SRC:NET& +MCU+PAS+RAKOIT:BAS:``& ``` -This request will return the current audio source +This request will return the current device bass level -Command: `MCU+PAS+RAKOIT:SRC&` +Command: `MCU+PAS+RAKOIT:BAS&` -Response: `MCU+PAS+RAKOIT:SRC{str_player_mode}&` +Response: `MCU+PAS+RAKOIT:BAS&`
+ `` Integer value of the bass level. Value range is from `-10dB to 10dB`
-### Select Device Audio Source -> Request format: - -```html -"MCU+PAS+RAKOIT:SRC:&:" -``` - -> Example Response: +### Select Device Bass Level +>Command: ```plaintext -NET = AXX+MEA+RDY AXX+PLY+000 -USB = AXX+MEA+RDY AXX+MEA+RDY AXX+PLY+PLA AXX+PLY+000 AXX+PLY+001 +MCU+PAS+RAKOIT:BAS``&: + +There is no Response for this command: ``` -Selects the Audio Source of the Device. The available audio sources for each device will depend on the installed hardware. +Sets the Bass Level of the Device. -Command: `MCU+PAS+RAKOIT:SRC:` +Command: `MCU+PAS+RAKOIT:BAS&` + `` Integer value of the bass level. Value range is from `-10dB to 10dB`
-Response | Description ----|--- -`AXX+MEA+RDY AXX+PLY+000` | Example reply -`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ -`MCU+PAS+ERR:SRC&` | Check with FZ \ No newline at end of file +Response: There is no response for this command. \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_BEP.md b/source/includes/tcp/_cmd_pair_BEP.md index 4e3d343..7080ca2 100644 --- a/source/includes/tcp/_cmd_pair_BEP.md +++ b/source/includes/tcp/_cmd_pair_BEP.md @@ -1,46 +1,54 @@ -## Device Main BEEP Tone (Enable/Disable) Command Pair `BEP` - +## Device Main BEEP Tone (Enable/Disable) - Command Pair ### Get BEEP Tone Status (Enabled/Disbled) -> Get Request format: +> Command:: -```html +```plaintext MCU+PAS+RAKOIT:BEP&: ``` > Example Response: ```plaintext -MCU+PAS+BEP:0& or MCU+PAS+BEP:1& +MCU+PAS+RAKOIT:BEP:0& // BEEP Disabled +MCU+PAS+RAKOIT:BEP:1& // BEEP Enabled ``` This request will return a boolean state of the BEEP Tone Enable/Disable Function Command: `MCU+PAS+RAKOIT:BEP&` -Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone Enabled - - +Response:
`MCU+PAS+RAKOIT:BEP:0&` BEEP Tone Disabled
`MCU+PAS+RAKOIT:BEP:1&` BEEP Tone Enabled +


### Set BEEP Tone Status (Enabled/Disbled) -> Set Request format: +> Command: + +```plaintext +MCU+PAS+RAKOIT:BEP:0& // Disable BEEP Tone +MCU+PAS+RAKOIT:BEP:1& // Enable BEEP Tone -```html -MCU+PAS+RAKOIT:BEP:1& or MCU+PAS+RAKOIT:BEP:0& ``` > Example Response: ```plaintext -MCU+PAS+BEP:0& -MCU+PAS+BEP:1& +MCU+PAS+RAKOIT:BEP:0& // BEEP Tone Disabled +MCU+PAS+RAKOIT:BEP:1& // BEEP Tone Enabled ``` Enables & Disables device main BEEP Tone. -Command: `MCU+PAS+RAKOIT:BEP:&` +Command: `MCU+PAS+RAKOIT:BEP:&` Parameter | Description ---|---|--- -`bool_or_toggle` | A boolean value
`1` Disable
`0` Enable
+`` | A boolean value
`0` Enable
`1` Disable
+ +Response:
+`MCU+PAS+RAKOIT:BEP:0&` BEEP Tone Disabled
+`MCU+PAS+RAKOIT:BEP:1&` BEEP Tone Enabled -Response:
`MCU+PAS+BEP:0&` BEEP Tone Disabled
`MCU+PAS+BEP:1&` BEEP Tone Enabled +Parameter | Description +---|---|--- +`0` | Disable +`1` | Enable diff --git a/source/includes/tcp/_cmd_pair_BTC.md b/source/includes/tcp/_cmd_pair_BTC.md new file mode 100644 index 0000000..f547780 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_BTC.md @@ -0,0 +1,54 @@ +## Device Bluetooth Connection - Command Pair +### Get Bluetooth Connection Status +>Command: + +```plaintext +MCU+PAS+RAKOIT:BTC&: +``` + +>Example Response: + +```plaintext +MCU+PAS+BTC:0& // Bluetooth connection not active +MCU+PAS+BTC:1& // Bluetooth connection active +``` +This request will return the boolean state of the Bluetooth connection, + +Command: `MCU+PAS+RAKOIT:BTC&` + +Response:
+`MCU+PAS+BTC:0&` Bluetooth connection not active
+`MCU+PAS+BTC:1&` Bluetooth connection active
+ + + +### Reconnect last active Bluetooth connection +>Command: + +```plaintext +MCU+PAS+RAKOIT:BTC:0& // Disconnect current Bluetooth connection +MCU+PAS+RAKOIT:BTC:1& // Reconnect to a last active Bluetooth connection +``` + +>Example Response: + +```plaintext +MCU+PAS+BTC:0& // Bluetooh disconnected +MCU+PAS+BTC:1& // Bluetooth connected +MCU+PAS+RAKOIT:ERR:INVALID& // Device is not in Bluetooth player mode +``` + +Connects and disconnects Bluetooth active connection when the player mode is Bluetooth. + +Command: `MCU+PAS+RAKOIT:BTC:&` + +Parameter | Description +---|---|--- +`` | A boolean value
`0` Disconnect Bluetooth
`1` Connect Bluetooth + +Response:
+`MCU+PAS+VBS:0&` Bluetooh disconnected
+`MCU+PAS+VBS:1&` Bluetooth connected
+`MCU+PAS+RAKOIT:ERR:INVALID&` Device is not in Bluetooth player mode \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_LED.md b/source/includes/tcp/_cmd_pair_LED.md index 50810bf..91a8965 100644 --- a/source/includes/tcp/_cmd_pair_LED.md +++ b/source/includes/tcp/_cmd_pair_LED.md @@ -1,6 +1,5 @@ -## Device Main LED +## Device Main LED - Command Pair ### Get LED Status - > Command: ```plaintext @@ -10,17 +9,20 @@ MCU+PAS+RAKOIT:LED&: > Example Response: ```plaintext -MCU+PAS+LED:0& // LED Disabled -MCU+PAS+LED:1& // LED Enabled +MCU+PAS+LED:0& // LED Disabled +MCU+PAS+LED:1& // LED Enabled ``` This command will return a boolean state of the LED Enable/Disable Function. -






+Command: `MCU+PAS+RAKOIT:LED&` -### Set LED Status +Response:
`MCU+PAS+RAKOIT:LED:0&` LED Disabled
`MCU+PAS+RAKOIT:LED:1&` LED Enabled -> Command: +


+ +### Set LED Status +>Command: ```plaintext MCU+PAS+RAKOIT:LED:0& // Disable LED @@ -31,14 +33,22 @@ MCU+PAS+RAKOIT:LED:T& // Toggle current LED status > Example Response: ```plaintext -MCU+PAS+LED:0& // LED Disabled -MCU+PAS+LED:1& // LED Enabled +MCU+PAS+RAKOIT:LED:0& // LED Disabled +MCU+PAS+RAKOIT:LED:1& // LED Enabled ``` Enables & Disables device main LED. -Parameter | Description +Command: `MCU+PAS+RAKOIT:LED:&` + +Value | Description ---|---|--- -`0` | Disable -`1` | Enable -`T` | Toggle current LED status +`0` | Enable +`1` | Disable +`T` | Toggle current LED status +
+ +Response:
+`MCU+PAS+RAKOIT:LED:0&` LED Disabled
+`MCU+PAS+RAKOIT:LED:1&` LED Enabled + diff --git a/source/includes/tcp/_cmd_pair_LPM.md b/source/includes/tcp/_cmd_pair_LPM.md index 78e5478..20e8af1 100644 --- a/source/includes/tcp/_cmd_pair_LPM.md +++ b/source/includes/tcp/_cmd_pair_LPM.md @@ -1,38 +1,61 @@ -## Device Volume Command Pair +## Device Repeat & Shuffle playback - Command Pair -### Get Device Volume -> Get command format: +These commands share a common parameter table -```html -"MCU+PAS+RAKOIT:VOL&: +Parameter | Description +---|--- +`` | Activates a combination of Shuffle and Repeat modes
`REPEATALL`: Shuffle disabled, Repeat enabled - loop
`REPEATONE`: Shuffle disabled, Repeat enabled - loop once
`REPEATSHUFFLE`: Shuffle enabled, Repeat enabled - loop
`SHUFFLE`: Shuffle enabled, Repeat disabled
SEQUENCE`: Shuffle disabled, Repeat disabled
`REPEATALL`: Shuffle enabled, Repeat enabled - loop once
+ + + +### Get Device Repeat & Shuffle Modes +>Command: + +```plaintext +"MCU+PAS+RAKOIT:LPM&: ``` > Example Response: ```plaintext -MCU+PAS+VOL:``& +MCU+PAS+RAKOIT+SRC:LPM& ``` -This request will return the current device volume level +This request will return a combination of the current shuffle & repeat mode status. -Command: `MCU+PAS+RAKOIT:VOL&` +Command: `MCU+PAS+RAKOIT:LPM&` -Response: `MCU+PAS+RAKOIT:VOL&` - `` Integer value of the volume level. Value range is from `0 - 100`
+Response: `MCU+PAS+RAKOIT:LPM&` See parameter table above. -### Select Device Volume -> Set command format: +### Set Device Repeat & Shuffle Modes +>Command: -```html -MCU+PAS+RAKOIT:VOL``&: +```plaintext +MCU+PAS+RAKOIT:SRC:``&: +``` -There is no Response for this command: +> Example Responses: +```plaintext +AXX+PLP+000 = REPEATALL +AXX+PLP+001 = REPEATONE +AXX+PLP+002 = REPEATSHUFFLE - REPEAT ALL & SHUFFLE +AXX+PLP+003 = -SHUFFLE +AXX+PLP+004 = - NO SHUFFLE NO REPEAT ``` -Sets the Volume of the Device. +Selects the desired combination of shuffle and repeat functions. + +Command: `MCU+PAS+RAKOIT::` -Command: `MCU+PAS+RAKOIT:VOL&` - `` Integer value of the volume level. Value range is from `0 - 100`
+`mode` | Playback mode
`` - `PLAYER_MODE_NONE`
`NET` - NET Blah Blah Blah
`USB` - USB disk pen drive connected to device)
`USBDAC` - `USB DAC e.g. Fromlap to connected with USB lead`
`BT` - Bluetooth Input
`LINE-IN` - Analogue Line in
`LINE-IN2` - `PLAYER_MODE_LINEIN2`
`OPT` - `PLAYER_MODE_OPTICAL`
`COAX` - `PLAYER_MODE_COAXIAL`
`I2S` - `PLAYER_MODE_I2S`
`HSMI` - HDMI IN`
-Response There is no response for this command. \ No newline at end of file + +NET/USB/USBDAC/LINE-IN/LINE-IN2/BT/OPT/COAX/I2S/HDMIResponse | Description +``` +`AXX+MEA+RDY AXX+PLY+000` | Example reply +`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ +`MCU+PAS+ERR:SRC&` | Check with FZ +``` \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_NAM.md b/source/includes/tcp/_cmd_pair_NAM.md index fe55030..0bac2fd 100644 --- a/source/includes/tcp/_cmd_pair_NAM.md +++ b/source/includes/tcp/_cmd_pair_NAM.md @@ -1,8 +1,7 @@ -## Device Name - +# Hardware Commands +## Device Name - Command Pair ### Get Device Name - -> Command: +>Command: ```plaintext MCU+PAS+RAKOIT:NAM&: @@ -14,19 +13,25 @@ MCU+PAS+RAKOIT:NAM&: MCU+PAS+RAKOIT:NAM:4E4F42425920424F58& ``` -This command will return the current device name. -Response: Is a hexadecimal string +This command will return the current device name as a hexadecimal string. + +Command: `MCU+PAS+RAKOIT:NAM&` + +Response: `MCU+PAS+RAKOIT:NAM&` + +Parameter | Description +---|---|--- +`` | Device name string (ascii characeters)

-



+


### Set Device Name - -> Command: +>Command: ```plaintext MCU+PAS+RAKOIT:NAM:& @@ -40,12 +45,15 @@ AXX+NAM+RAKOIT:& Sets the device name. +Command: `MCU+PAS+RAKOIT:NAM&` + +Response: `MCU+PAS+RAKOIT:&` + Parameter | Description ---|---|--- -`hex_str_name` | Device name string (hexadecimal) -`ascii_str_name` | Device name string (ascii characeters) +`` | Device name string (hexadecimal) +`` | Device name string (ascii characeters) -Response:
`MCU+PAS+RAKOIT:&`