Marantz AV8805 HEOS CLI PROTOCOL Specification - Page 7

Command and Response Details

Get Marantz AV8805 PDF manuals and user guides View all Marantz AV8805 manuals
Add to My Manuals
Save this manual to your list of manuals

Page 7 highlights

4. Command and Response Details 4.1 System Commands 4.1.1 Register for Change Events By default HEOS speaker does not send Change events. Controller needs to send this command with enable=on when it is ready to receive unsolicit responses from CLI. Please refer to "Driver Initialization" section regarding when to register for change events. Command: heos://system/register_for_change_events?enable='on_or_off' Attribute Description Enumeration enable Register or unregister for change events. on,off Response: { "heos": { "command": "system/register_for_change_events", "result": "success", "message": "enable='on_or_off'" } } Example: heos://system/register_for_change_events?enable=on 4.1.2 HEOS Account Check Command: heos://system/check_account This command returns current user name in its message field if the user is currently singed in. Response: { "heos": { "command": "system/check_account", "result": "success", "message": "signed_out" or "signed_in&un=" } } Example: heos://system/check_account 4.1.3 HEOS Account Sign In Command: heos://system/sign_in?un=heos_username&pw=heos_password Attribute Description Enumeration un HEOS account username N/A pw HEOS account password N/A Response: { "heos": { "command": "system/sign_in ", "result": "success", "message": "signed_in&un=" } } Example: heos://system/[email protected]&pw=12345 4.1.4 HEOS Account Sign Out

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
4. Command and Response Details
4.1 System Commands
4.1.1 Register for Change Events
By default HEOS speaker does not send Change events. Controller needs to send this command with enable=on when it is ready to
receive unsolicit responses from CLI. Please refer to "Driver Initialization" section regarding when to register for change events.
Command: heos://system/register_for_change_events?enable='on_or_off'
Attribute
Description
Enumeration
enable
Register or unregister for change events.
on,off
Response:
{
"heos": {
"command": "system/register_for_change_events",
"result": "success",
"message": "enable='on_or_off'"
}
}
Example: heos://system/register_for_change_events?enable=on
4.1.2 HEOS Account Check
Command: heos://system/check_account
This command returns current user name in its message field if the user is currently singed in.
Response:
{
"heos": {
"command": "system/check_account",
"result": "success",
"message": "signed_out" or "signed_in&un=<current user name>"
}
}
Example: heos://system/check_account
4.1.3 HEOS Account Sign In
Command: heos://system/sign_in?un=heos_username&pw=heos_password
Attribute
Description
Enumeration
un
HEOS account username
N/A
pw
HEOS account password
N/A
Response:
{
"heos": {
"command": "system/sign_in ",
"result": "success",
"message": "signed_in&un=<current user name>"
}
}
Example: heos://system/[email protected]&pw=12345
4.1.4 HEOS Account Sign Out