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 new file mode 100644 index 0000000..acf21d9 --- /dev/null +++ b/source/includes/tcp/_cmd_network.md @@ -0,0 +1,60 @@ +# Connection Status Commands + +### Get Status of Ethernet Connection (RJ45 Network) +> Command: + +```plaintext +MCU+PAS+RAKOIT:ETH&: +``` + +> Example Response: + +```plaintext +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 + +


+### Get Status of Wireless Connection (WiFi Network) +>Command:: + +```plaintext +MCU+PAS+RAKOIT:WIF&: +``` + +> Example Response: + +```plaintext +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: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 +>Command: + +```plaintext +MCU+PAS+RAKOIT:WWW&: +``` + +> Example Response: + +```plaintext +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: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 new file mode 100644 index 0000000..77b8de5 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_BAS.md @@ -0,0 +1,37 @@ +## Device Bass Level - Command Pair +### Get Device Bass Level +>Command: + +```plaintext +MCU+PAS+RAKOIT:BAS& +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:BAS:``& +``` + +This request will return the current device bass level + +Command: `MCU+PAS+RAKOIT:BAS&` + +Response: `MCU+PAS+RAKOIT:BAS&`
+ `` Integer value of the bass level. Value range is from `-10dB to 10dB`
+ + +### Select Device Bass Level +>Command: + +```plaintext +MCU+PAS+RAKOIT:BAS``&: + +There is no Response for this command: +``` + +Sets the Bass Level of the Device. + +Command: `MCU+PAS+RAKOIT:BAS&` + `` Integer value of the bass level. Value range is from `-10dB to 10dB`
+ +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 new file mode 100644 index 0000000..7080ca2 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_BEP.md @@ -0,0 +1,54 @@ +## Device Main BEEP Tone (Enable/Disable) - Command Pair +### Get BEEP Tone Status (Enabled/Disbled) +> Command:: + +```plaintext +MCU+PAS+RAKOIT:BEP&: +``` + +> Example Response: + +```plaintext +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+RAKOIT:BEP:0&` BEEP Tone Disabled
`MCU+PAS+RAKOIT:BEP:1&` BEEP Tone Enabled + +


+ +### Set BEEP Tone Status (Enabled/Disbled) +> Command: + +```plaintext +MCU+PAS+RAKOIT:BEP:0& // Disable BEEP Tone +MCU+PAS+RAKOIT:BEP:1& // Enable BEEP Tone + +``` + +> Example Response: + +```plaintext +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:&` + +Parameter | Description +---|---|--- +`` | A boolean value
`0` Enable
`1` Disable
+ +Response:
+`MCU+PAS+RAKOIT:BEP:0&` BEEP Tone Disabled
+`MCU+PAS+RAKOIT: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 new file mode 100644 index 0000000..91a8965 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_LED.md @@ -0,0 +1,54 @@ +## Device Main LED - Command Pair +### Get LED Status +> Command: + +```plaintext +MCU+PAS+RAKOIT:LED&: +``` + +> Example Response: + +```plaintext +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&` + +Response:
`MCU+PAS+RAKOIT:LED:0&` LED Disabled
`MCU+PAS+RAKOIT:LED:1&` LED Enabled + +


+ +### Set LED Status +>Command: + +```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+RAKOIT:LED:0& // LED Disabled +MCU+PAS+RAKOIT:LED:1& // LED Enabled +``` + +Enables & Disables device main LED. + +Command: `MCU+PAS+RAKOIT:LED:&` + +Value | Description +---|---|--- +`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 new file mode 100644 index 0000000..20e8af1 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_LPM.md @@ -0,0 +1,61 @@ +## Device Repeat & Shuffle playback - Command Pair + +These commands share a common parameter table + +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+RAKOIT+SRC:LPM& +``` + +This request will return a combination of the current shuffle & repeat mode status. + +Command: `MCU+PAS+RAKOIT:LPM&` + +Response: `MCU+PAS+RAKOIT:LPM&` See parameter table above. + + +### Set Device Repeat & Shuffle Modes +>Command: + +```plaintext +MCU+PAS+RAKOIT:SRC:``&: +``` + +> 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 +``` + +Selects the desired combination of shuffle and repeat functions. + +Command: `MCU+PAS+RAKOIT::` + +`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`
+ + +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 new file mode 100644 index 0000000..0bac2fd --- /dev/null +++ b/source/includes/tcp/_cmd_pair_NAM.md @@ -0,0 +1,60 @@ +# Hardware Commands +## Device Name - Command Pair +### Get Device Name +>Command: + +```plaintext +MCU+PAS+RAKOIT:NAM&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:NAM:4E4F42425920424F58& +``` + +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: + +```plaintext +MCU+PAS+RAKOIT:NAM:& +``` + +> Example Response: + +```plaintext +AXX+NAM+RAKOIT:& +``` + +Sets the device name. + +Command: `MCU+PAS+RAKOIT:NAM&` + +Response: `MCU+PAS+RAKOIT:&` + +Parameter | Description +---|---|--- +`` | Device name string (hexadecimal) +`` | Device name string (ascii characeters) + + + \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_SRC.md b/source/includes/tcp/_cmd_pair_SRC.md new file mode 100644 index 0000000..873c08d --- /dev/null +++ b/source/includes/tcp/_cmd_pair_SRC.md @@ -0,0 +1,56 @@ +## Device Status - Command Pair + +These commands share a common parameter table composed of strings. + +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 +>Command: + +```plaintext +MCU+PAS+RAKOIT:SRC&: +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:SRC``& +``` + +This request will return the current player mode / audio source + +Command: `MCU+PAS+RAKOIT:SRC&` + +Response: `MCU+PAS+RAKOIT:SRC&` + +


+### Select Device Audio Source +>Command: + +```plaintext +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 +BT = AXX+MEA+RDY AXX+MEA+RDY AXX+PLY+PLA +``` + +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: +`AXX+MEA+RDY AXX+PLY+000` | Example reply +`MCU+PAS+ERR:UNSUPPORTED&` | Check with FZ +`MCU+PAS+ERR:SRC&` | Check with FZ + + + diff --git a/source/includes/tcp/_cmd_pair_TRE.md b/source/includes/tcp/_cmd_pair_TRE.md new file mode 100644 index 0000000..2f633d2 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_TRE.md @@ -0,0 +1,37 @@ +## Device Treble Level - Command Pair +### Get Device Treble Level +>Command: + +```plaintext +MCU+PAS+RAKOIT:TRE& +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT:TRE:``& +``` + +This request will return the current device treble level + +Command: `MCU+PAS+RAKOIT:TRE&` + +Response: `MCU+PAS+RAKOIT:TRE&`
+ `` Integer value of the treble level. Value range is from `-10dB to 10dB`
+ + +### Select Device Treble Level +>Command: + +```plaintext +MCU+PAS+RAKOIT:TRE``&: + +There is no Response for this command: +``` + +Sets the treble Level of the Device. + +Command: `MCU+PAS+RAKOIT:TRE&` + `` Integer value of the treble level. Value range is from `-10dB to 10dB`
+ +Response: There is no response for this command. \ No newline at end of file diff --git a/source/includes/tcp/_cmd_pair_VBS.md b/source/includes/tcp/_cmd_pair_VBS.md new file mode 100644 index 0000000..e2d4c36 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_VBS.md @@ -0,0 +1,46 @@ +## Device Virtual Bass (Enable/Disable) - Command Pair +### Get Virtual Bass Status (Enabled/Disbled) +>Command: + +```plaintext +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) +>Command: + +```plaintext +MCU+PAS+RAKOIT:VBS:0& // Disable Virtual Bassa +MCU+PAS+RAKOIT:VBS:1& // Enable Virtual Bass +MCU+PAS+RAKOIT:VBS:T& // Toggle current Virtual Bass status +``` + +> Example Response: + +```plaintext +MCU+PAS+VBS:0& // VBS Disabled +MCU+PAS+VBS:1& // VBS Enabled +``` + +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_pair_VOL.md b/source/includes/tcp/_cmd_pair_VOL.md new file mode 100644 index 0000000..6bbd4a4 --- /dev/null +++ b/source/includes/tcp/_cmd_pair_VOL.md @@ -0,0 +1,38 @@ +## Device Volume - Command Pair + +### Get Device Volume +>Command: + +```plaintext +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 +>Command: + +```plaintext +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 new file mode 100644 index 0000000..92798c4 --- /dev/null +++ b/source/includes/tcp/_cmd_playback.md @@ -0,0 +1,43 @@ +# Playback Commands + +### Play Preset Content +>Command: + +```plaintext +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` + +### Mute Device +>Command: + +```plaintext +"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/_cmd_query_status.md b/source/includes/tcp/_cmd_query_status.md new file mode 100644 index 0000000..b518317 --- /dev/null +++ b/source/includes/tcp/_cmd_query_status.md @@ -0,0 +1,38 @@ +# Device Status & Sources +### Get the Current Device Status +>Command: + +```plaintext +MCU+PAS+RAKOIT:STA& +``` + +> Example Response: + +```plaintext +MCU+PAS+RAKOIT: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:,,,,,,,,,&` + +### Description of response values + +Key | Value Description +---|--- +`` | Playback mode<
`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 +`` | A boolean value indicating if mute is active
`0` mute not active
`1` mute active. +`` | Current volume
The integer range is from `0 to 100`. So can be considered a linear percentage (`0% to 100%`) +`` | Current treble level
The integer range is from `-10 to 10`. This corresponds to `-10dB` & `+10dB` +`` | Current bass level
The integer range is from `-10 to 10`. This corresponds to `-10dB` & `+10dB` +`` | A boolean value indicating current device local network status
`0` Not on local network
`1` Device on local network. +`` | A boolean value indicating current device internet connection status
`0` No internet connection
`1` Internet connection active +`` | A boolean value indicating if playback is active
`0` Playback not active
`1` Playback active +`` | A boolean value indicating if main LED light is enabled or disabled
`0` LED disabled
`1` LED enabled +`` | 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 new file mode 100644 index 0000000..73db7e1 --- /dev/null +++ b/source/includes/tcp/_cmd_system.md @@ -0,0 +1,75 @@ +# System Commands + +The following commands are all "system" commands 'SYS' + +Command: `MCU+PAS+RAKOIT:SYS:&` + +### Factory Reset +>Command: + +```plaintext +MCU+PAS+RAKOIT:SYS:RESET& +``` + +> Example Response: + +```plaintext +AXX+FACTORY AXX+PMT+000 AXX+MUT+000 AXX+DEV+RST +``` + +This will stop playback and reset the device to factory settings. +The response string will confirm that the command has been accepted. + +Command: `MCU+PAS+RAKOIT:SYS:RESET&` + +Response: `AXX+FACTORY AXX+PMT+000 AXX+MUT+000 AXX+DEV+RST`
+ + + +


+ +### System Reboot +>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. +This command will reboot the whole device including the base board and the wifi module. + +Command: `MCU+PAS+RAKOIT:SYS:REBOOT&` + +Response: There is no response for this command
+ + + +


+ +### System Standby +>Command: + +```plaintext +"MCU+PAS+RAKOIT:SYS:STANDBY&" +``` + +> No Response: + +This will stop playback immediately and power off the device. + +Command: `MCU+PAS+RAKOIT:SYS:STANBY&` + +Response: There is no response for this command
+ + + + + diff --git a/source/includes/tcp/_intro_welcome.md b/source/includes/tcp/_intro_welcome.md index 855f1fa..580ab10 100644 --- a/source/includes/tcp/_intro_welcome.md +++ b/source/includes/tcp/_intro_welcome.md @@ -1,3 +1,41 @@ # TCP API Welcome to Arylic's TCP API developer documentation. + +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 + +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 + +**Connection configuration commands:** + + * `BTC` - BT connection blah blah + \ 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..219447f --- /dev/null +++ b/source/includes/tcp/notes.txt @@ -0,0 +1,14 @@ +KPW Notes - October 2021 + +MCU+PAS+RAKOIT:SYS:REBOOT& +Are we sure the Wifi Module is rebooted? The reboot is very quick !!! + +Formattiing Example +Parameter | Description +---|---|--- +`0` | Disable +`1` | Enable +`T` | Toggle current LED status + +### Select Device Audio Source +send string e.g. BT, NET, Returns Non Rakoit PLayer modes e.g. flag_player_mode \ 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 diff --git a/source/tcp-index.md b/source/tcp-index.md index e3d45fb..d30cfcd 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: @@ -10,6 +10,31 @@ toc_footers: includes: - tcp/intro_welcome + # SYSTEM COMMANDS + - tcp/cmd_system + + # HARDWARE/DEVICE COMMANDS + - tcp/cmd_pair_NAM + - tcp/cmd_pair_LED + - tcp/cmd_pair_BEP + - tcp/cmd_CHN + + # CONNECTION STATUS COMMANDS + - tcp/cmd_network + - tcp/cmd_pair_BTC + + # 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 code_clipboard: false