Sound Control Protocol for SpeechLine Digital Wireless

SSC Developer‘s guide for SpeechLine Digital Wireless | 89/109
SSC Method List (CHG 2N/CHG 4N)
14.6 /osc/limits
Parameter type: N.A.
Permission: N.A..
Pre-condition: N.A.
Post-condition: N.A.
Description: The /osc/limits method allows clients to query what kind of values and what range are
accepted by the server in an SSC Method call as parameter values. The response of the request is
always a JSON array containing a JSON object describing properties of the addressed SSC Method.
The property list is extensible for application-specific features as well as for revised versions of this
specification.
Optional properties are:
• type string "Number", "String", "Boolean", or "Container"
• min number minimum valid value
• max number maximum valid value
• inc number recommended user interface increment value
• units string String describing value units (preferably SI)
• desc string descriptive text, meant for display to the user
• option string array of all allowed options for the value
• option_desc string array with description text relating to the option values
The language for "units", "description" and "option_desc" MAY depend on /device/language.
Examples:
TX: {"osc":{"limits":[{"bays":{"bat_bars":null}}]}}
RX: {"osc":{"limits":[{"bays":{"bat_bars":[{"type":"Number","max":6,
"min":0,"inc":1,"units":"bars"}]}}]}}
TX: {"osc":{"limits":[{"bays":{"state":}}]}}
RX: {"osc":{"limits":[{"bays":{"state":[{"type":"Number","desc":
"Bays status","option":[0,1,2],"option_desc":["NORMAL","FWU",
"ERROR"]}]}}]}}
14.7 /osc/feature/pattern
Parameter type: String.
Permission: Read only.
Pre-condition: N.A.
Post-condition: N.A.
Description: Support for address pattern matching is OPTIONAL for an SSC Server; it MAY be left out
in a restricted implementation. If the SSC Server does not support address pattern matching, it MUST
treat the special pattern characters like normal characters. An SSC Client can find out whether ad-
dress patterns are supported by receiving error replies, or by calling the SSC Method /osc/feature/
pattern
Example:
TX: {"osc":{"feature":{"pattern":null}}}
RX: {"osc":{"feature":{"pattern":"*?"}}}
14.8 /osc/feature/baseaddr
Parameter type: Boolean.
Permission: Read only.
Pre-condition: N.A.
Post-condition: N.A.