Sound Control Protocol for (Firmware 1.8.0)
Table Of Contents
- 1. Introduction
- 2. Open Sound Control Overview
- 3. Conventions
- 4. SSC Data Structure Specification
- 5. General SSC Address Schema
- 5.1 SSC Meta Information - /osc
- 5.1.1 SSC Protocol version - /osc/version
- 5.1.2 SSC error state - /osc/error
- 5.1.3 SSC transaction ID - /osc/xid
- 5.1.4 SSC Ping - /osc/ping
- 5.1.5 SSC Schema reflection - /osc/schema
- 5.1.6 SSC Method parameter range reflection - /osc/limits
- 5.1.7 Session-specific SSC Address Space - /osc/state
- 5.1.8 SSC Session termination - /osc/state/close
- 5.1.9 SSC subscriptions - /osc/state/subscribe
- 5.1.10 SSC reply output style - /osc/state/prettyprint
- 5.1.11 SSC interactive method address base - /osc/state/baseaddr
- 5.1.12 SSC timed method execution - /osc/timetag
- 5.1.13 SSC Method time stamps - /osc/timestamp
- 5.1.14 SSC Method Authorisation - /osc/tan
- 5.1.15 SSC protocol feature reflection - /osc/feature
- 5.2 Generic Device Information and Settings: Address Space - /device
- 5.1 SSC Meta Information - /osc
- 6. SSC Transport Layer Adaptations
- 6.1 UDP/IP
- 6.2 TCP/IP
- 6.3 HTTP(S)/TCP/IP
- 6.4 Secure Shell Transport/TCP/IP
- 6.5 SSC Server Discovery
- 6.6 IEEE 802.15.4 / ZigBee / DECT
- 6.7 Low-bandwidth serial infrared link
- 6.8 Byte-stream connections (serial interface etc.)
- 6.9 Unidirectional low-bandwidth monitoring
- 6.10 Configuration files
- 6.11 Scripting files
- 6.12 Apendix
- 6.13 References
- 7. SSC Method List
- 7.1 "/m/beam/elevation"
- 7.2 "/m/beam/azimuth"
- 7.3 "/m/in1/peak"
- 7.4 "/m/ref1/rms"
- 7.5 "/device/identification/visual"
- 7.6 "/device/button/state"
- 7.7 "/device/button/label"
- 7.8 "/device/button/description"
- 7.9 "/device/identity/version"
- 7.10 "/device/identity/vendor"
- 7.11 "/device/identity/serial"
- 7.12 "/device/identity/product"
- 7.13 "/device/identity/hw_revision"
- 7.14 "/device/update/progress"
- 7.15 "/device/update/error"
- 7.16 "/device/update/enable"
- 7.17 "/device/led/custom/color"
- 7.18 "/device/led/custom/active"
- 7.19 "/device/led/mic_mute/color"
- 7.20 "/device/led/mic_on/color"
- 7.21 "/device/led/show_farend_activity"
- 7.22 "/device/led/brightness"
- 7.23 "/device/network/ether/macs"
- 7.24 "/device/network/ether/interfaces"
- 7.25 "/device/network/ipv4/netmask"
- 7.26 "/device/network/ipv4/manual_netmask"
- 7.27 "/device/network/ipv4/manual_ipaddr"
- 7.28 "/device/network/ipv4/manual_gateway"
- 7.29 "/device/network/ipv4/ipaddr"
- 7.30 "/device/network/ipv4/interfaces"
- 7.31 "/device/network/ipv4/gateway"
- 7.32 "/device/network/ipv4/auto"
- 7.33 "/device/network/mdns"
- 7.34 "/device/timeprecision"
- 7.35 "/device/time"
- 7.36 "/device/system"
- 7.37 "/device/position"
- 7.38 "/device/name"
- 7.39 "/device/location"
- 7.40 "/device/language"
- 7.41 "/device/date"
- 7.42 "/device/restore"
- 7.43 "/device/restart"
- 7.44 "/interface/version"
- 7.45 "/audio/equalizer/preset"
- 7.46 "/audio/equalizer/custom"
- 7.47 "/audio/exclusion/zones"
- 7.48 "/audio/exclusion/active"
- 7.49 "/audio/exclusion_zone/azimuth/3"
- 7.50 "/audio/exclusion_zone/azimuth/2"
- 7.51 "/audio/exclusion_zone/azimuth/1"
- 7.52 "/audio/exclusion_zone/elevation/1"
- 7.53 "/audio/noise_gate/threshold"
- 7.54 "/audio/noise_gate/hold_time"
- 7.55 "/audio/noise_gate/active"
- 7.56 "/audio/out1/label"
- 7.57 "/audio/out1/desc"
- 7.58 "/audio/out1/attenuation"
- 7.59 "/audio/out2/identity/version"
- 7.60 "/audio/out2/network/ether/macs"
- 7.61 "/audio/out2/network/ether/interfaces"
- 7.62 "/audio/out2/network/ether/interface_mapping"
- 7.63 "/audio/out2/network/ipv4/netmask"
- 7.64 „/audio/out2/network/ipv4/manual_ipaddr“
- 7.65 „/audio/out2/network/ipv4/manual_gateway“
- 7.66 "/audio/out2/network/ipv4/ipaddr"
- 7.67 "/audio/out2/network/ipv4/interfaces"
- 7.68 "/audio/out2/network/ipv4/gateway"
- 7.69 „/audio/out2/network/ipv4/auto“
- 7.70 "/audio/out2/label"
- 7.71 "/audio/out2/gain"
- 7.72 "/audio/out2/desc"
- 7.73 "/audio/priority/zones"
- 7.74 "/audio/priority/weights"
- 7.75 "/audio/priority/active"
- 7.76 "/audio/ref1/label"
- 7.77 "/audio/ref1/gain"
- 7.78 "/audio/ref1/farend_auto_adjust_enable"
- 7.79 "/audio/ref1/desc"
- 7.80 "/audio/source_detection/threshold"
- 7.81 "/audio/voice_lift/emergency_mute_time"
- 7.82 "/audio/voice_lift/emergency_mute_threshold"
- 7.83 "/audio/voice_lift/active"
- 7.84 "/audio/room_in_use"
- 7.85 "/audio/mute"
- 7.86 "/audio/installation_type"
- 7.87 "/beam/orientation/visual"
- 7.88 "/beam/orientation/offset"
- 7.89 "/osc/state/auth/access"
- 7.90 "/osc/state/prettyprint"
- 7.91 "/osc/state/close"
- 7.92 "/osc/state/subscribe"
- 7.93 "/osc/feature/timetag"
- 7.94 "/osc/feature/baseaddr"
- 7.95 "/osc/feature/subscription"
- 7.96 "/osc/feature/pattern"
- 7.97 "/osc/limits"
- 7.98 "/osc/schema"
- 7.99 "/osc/version"
- 7.100 "/osc/xid"
- 7.101 "/osc/ping"
- 7.102 "/osc/error"
SSC Developer‘s guide for TeamConnect Ceiling 2 | 44/68
SSC Method List
Example SSC request:
{"device":{"network":{"ipv4":{"manual_netmask":null}}}}
Example SSC response:
{"device":{"network":{"ipv4":{"manual_netmask":["255.255.254.0"]}}}}
7.27 "/device/network/ipv4/manual_ipaddr"
List of IPv4 addresses which will be applied after setting "device/network/ipv4/auto" to "false".
• type: String
• default: ["192.168.178.23"]
• const: false
• writeable: true
• count: 1
• subscr: true
Example SSC set:
{"device":{"network":{"ipv4":{"manual_ipaddr":["192.168.178.23"]}}}}
Example SSC subscr:
{"osc":{"state":{"subscribe":[ {"device":{"network":{"ipv4":
{"manual_ipaddr":null}}}}]}}}
Example SSC request:
{"device":{"network":{"ipv4":{"manual_ipaddr":null}}}}
Example SSC response:
{"device":{"network":{"ipv4":{"manual_ipaddr":["192.168.178.23"]}}}}
7.28 "/device/network/ipv4/manual_gateway"
List of IPv4 gateways which will be applied after setting "device/network/ipv4/auto" to "false".
• type: String
• default: ["192.168.178.1"]
• const: false
• writeable: true
• count: 1
• subscr: true
Example SSC set:
{"device":{"network":{"ipv4":{"manual_gateway":["192.168.178.1"]}}}}
Example SSC subscr:
{"osc":{"state":{"subscribe":[ {"device":{"network":{"ipv4":
{"manual_gateway":null}}}}]}}}
Example SSC request:
{"device":{"network":{"ipv4":{"manual_gateway":null}}}}
Example SSC response:
{"device":{"network":{"ipv4":{"manual_gateway":["192.168.178.1"]}}}}
7.29 "/device/network/ipv4/ipaddr"
List of current IPv4 addresses.
• type: String
• default: ["192.168.178.23"]
• const: false
• writeable: false
• count: 1
• subscr: true