Yamaha CS-700 Series Integrators Reference Manual Download Page 43

Page: 43 / 166

Yamaha CS-700 Integrators Reference Guide

Command Definition:

Action

Definition

get

get upgrade-status

response

val upgrade-status <"status">

notify

notify sys.upgrade-status <"status">

Parameters:

Parameter

Description

Ready

Ready for upgrade

Downloading

Downloading upgrade file

Failed

Upgrade failed.

Flashing

Writing upgrade to flash memory.

WaitingCallEnd

If any call is active, upgrade suspended until call ends.

Rebooting

Upgrade complete, rebooting system.

CLI Format Examples:

get upgrade-status

val upgrade-status Flashing

notify sys.upgrade-status Flashing

Supported Products: CS700-AV, CS700-SP

Available in API Version: 1.0

camera-upgrade-status

Description:

Indicates the camera module upgrade status.

Property Actions:

get, notify

Command Definition:

Action

Definition

get

get camera-upgrade-status

response

val camera-upgrade-status <"upgrade-status">

notify

notify sys.camera-upgrade-status <"upgrade-status">

Parameters:

Parameter

Description

Started

Upgrade has started.

Downloading

Downloading upgrade file.

Rebooting

Rebooting after upgrade.

Complete

Upgrade successful and complete.

Failed

Upgrade failed

pmuterogress

Progress of update. This string will be followed by percent complete.

Current

This is synonymous with complete. Revision of upgrade and current FW match.

Summary of Contents for CS-700 Series

Page 1: ...Yamaha CS 700 Integrators Reference Guide Revision 4 5 4 16 2019 Yamaha Unified Communications 144 North Road Suite 3250 Sudbury MA 01776 978 610 4040 ...

Page 2: ... the Camera Component 11 2 4 1 Video Configuration and Status 11 2 4 2 Video Stream 12 3 IP Interface 13 echo 14 4 Library Interface 14 4 1 USB Library Reference 15 CsDevComm_Mode enum 15 devAttach 15 devDetach 16 isConnected 16 coreCliCmd 16 notifCtrl 17 updateFirmware 17 downloadLogs 18 importConfig 18 exportConfig 19 5 API Command Reference 19 5 1 Overview 19 5 2 Categories 20 5 2 1 System 20 5...

Page 3: ...provisioning interval 35 snmp enable 36 snmp community 37 snmp contact name 37 snmp device location 38 dialer connection mode 38 snmp address 40 verbose log enabled 40 ui mask 41 5 2 1 2 System Statuses 42 usb conn status 42 upgrade status 42 camera upgrade status 43 power saving status 44 usb aud rx status 44 usb aud tx status 45 5 2 1 3 System Commands 45 regnotify 45 restart 46 set reset settin...

Page 4: ...amera door 57 camera mute 57 camera pan 58 camera tilt 59 camera zoom 59 camera backlight 60 camera brightness 61 camera contrast 61 camera saturation 62 camera sharpness 63 camera hue 63 camera gamma 64 5 2 3 3 Camera Commands 65 cam save as default 65 cam apply defaults 65 cam image save as default 66 cam image apply defaults 66 cam zoom in 66 cam zoom out 67 cam pan left 67 cam pan right 67 cam...

Page 5: ...bt disconnect 74 nfc enable 75 5 2 5 Call 76 5 2 5 1 Call Statuses 76 status 76 status all 77 call info 77 number 78 caller 79 start time 79 codec 80 call quality 80 5 2 5 2 Call Commands 81 dial 81 answer 82 hangup 82 hold 83 resume 83 swap 84 join 84 transfer 85 play ring tone 85 5 2 6 Network 86 5 2 6 1 Network Properties 86 mac 86 dhcp 86 ip 87 subnet 87 gateway 88 dns1 89 dns2 89 vlan 90 vlan...

Page 6: ...98 proxy 98 reg use proxy 99 user 100 password 100 id 101 name 101 reg timeout 102 rereg delay 103 use timer 103 timer se 104 timer min se 105 use 100rel 106 auto update nat 106 dtmf method 107 dtmf rtp payload type Error Bookmark not defined media onhold method 108 use srtp 109 rtp port 110 set qos 110 udp tcp selection 111 local port 112 ip addr 112 bound addr 113 no refer sub 114 min size 115 a...

Page 7: ... answer 130 duration 131 dial plan 131 always forwarding 132 always forwarding num 133 busy forwarding 133 busy forwarding num 134 noanswer forwarding 134 noanswer forwarding num 135 noanswer delay 136 5 2 7 2 VoIP Statuses 136 registration 136 5 2 7 3 VoIP Commands 137 set dtmf 137 set voip commit 138 6 Provisioning 138 6 1 Provisioning Files 139 6 2 Provisioning File Parameters 140 7 SNMP 158 Ap...

Page 8: ... device over IP Library Interface Describes the C library interface that can be used to create applications to manage and control the device over USB API Command Reference Provide details of the API commands and notifications that can be communicated between the host and device via the library and the IP interface Provisioning Describes how to provision the device via an IP connection using DHCP o...

Page 9: ...TT Hub Universal Serial Bus Controller USB 3 0 Hub 2 3 Interface Definitions for the Audio Component The USB Audio chip will enumerate the following interfaces Interface 0 Audio Control ep0 input type 0x101 output type 0x405 bma control 3 Interface 1 Audio Output Streaming ep1 OUT ISOC async 2 channel 48 KHz 16 24 bit 192 bytes Interface 2 Audio Input Streaming ep2 IN ISOC sync 2 channel 48 KHz 16...

Page 10: ...zation The speaker volume can be controlled from the device by using the volume up down cap touch buttons on the base unit Mic Mute States Mic Mute ep0 0x06 0x00 Control Transfer from Host Mic Unmute ep0 0x06 0x01 Control Transfer from Host Speaker Volume Gain Speaker volume ep0 0x02 value To CS 700 from Host Speaker Volume Control Volume Up ep4 0x01 0x01 Host responds with Control Transfer speake...

Page 11: ...ra interface will conform to USB Device Class Definition for Video Devices version 1 5 The USB Camera chip will enumerate the following interfaces USB 2 0 Interface 0 BULK ep1 in out 512 bit packet size USB 3 0 Interface 0 Video Control Interrupt ep2 IN 1024 bit packet size Interface 1 Video Streaming BULK ep3 IN 1024 bit packet size 2 4 1 Video Configuration and Status The video controls for pan ...

Page 12: ... Range 0 180 Gamma 0x09 value Range 1 255 Flicker 0x05 value 1 50Hz 2 60Hz 2 4 2 Video Stream Skype video specifications specify the following USB 2 0 o 640 x 480 30 fps YUY2 color space o 640 x 360 30 fps YUY2 color space USB 3 0 o 1920 x 1080 30 fps YUY2 NV12 color space o 1280 x 720 30 fps YUY2 NV12 color space o 640 x 360 30 fps YUY2 NV12 color space Note The CS 700 video camera only supports ...

Page 13: ...s the device via an IP connection then the client can communicate via the IP supported commands To use an IP connection for the control with the CS 700 being the server the Enable telnet access check box on the Admin Settings page has to be checked To start the IP connection provide the IP address port number user name and password in a telnet client to establish the connection The login username ...

Page 14: ...ement or operational control will find it most convenient to use the CS 700 Management Library This is a C library that is available for Windows and MacOS It enables developers to access the device using higher level functions without needing to directly manage the low level USB HID or bulk interface The library supports these features Connect to a device via USB Transmit API commands Receive API ...

Page 15: ...Hid CsDevComm_Mode_Bulk CsDevComm_Mode_Num CsDevComm_Mode devAttach Description Establish USB communication with a device Syntax EXPORT int __cdecl devAttach int mode void debug_callback char msg void event_callback int type Parameters Parameter Description Mode The USB connection mode Auto HID or Bulk chosen from enum CsDevComm_Mode debug_callback Pointer to callback function to handle debug mess...

Page 16: ...__cdecl isConnected void Return Values Value Description 1 General error 0 Not connected 1 Connected HID 2 Conned Bulk coreCliCmd Description Send a CLI format command to the device The commands are defined in in section 5 API Command Reference Syntax EXPORT int __cdecl coreCliCmd char cmd char rsp int len Parameters Parameter Description cmd CLI command string see API Command Reference rsp Pointe...

Page 17: ...f_callback_t Pointer to callback function to handle CLI notification msg Callback function parameter Notification message string see API Command Reference Return Values Value Description 1 General failure 0 Success updateFirmware Description Update firmware on the CS 700 device The host PC must have access to a proper firmware bundle Syntax EXPORT int __cdecl updateFirmware char bundle void update...

Page 18: ...t completion A value of 1 indicates a download error logname Returned name of downloaded log file Return Values Value Description 1 General failure 0 Success importConfig Description Import a configuration XML file to the CS 700 device The host PC must have access to a proper configuration file The output of this is the zipped config file after completion Syntax EXPORT int __cdecl importConfig cha...

Page 19: ...rt progress notifications nPercent Callback function parameter Percent completion A value of 1 indicates an export error filepath Callback function parameter Returned name of downloaded config file Return Values Value Description 1 General failure 0 Success 5 API Command Reference This section describes the API commands and notifications that can be transmitted between a device and host using the ...

Page 20: ...s set property can be set notify when the property changes a notification is sent to registered clients The Command Definition and Parameters tables describe each supported action and associated parameters and values 5 2 Categories The API is organized by these Categories System sys Audio Camera Bluetooth bt Bluetooth Low Energy ble Call Network net VoIP The sections below describe the interfaces ...

Page 21: ... 1 0 base sernum Description Query product serial number Read only set at manufacturing Property Actions get Command Definition Action Definition get get base sernum response val base sernum number Parameters Parameter Description number String Device serial number CLI Format Examples get base sernum val base sernum CSS701000062 Supported Products CS700 AV CS700 SP Available in API Version 1 0 voi...

Page 22: ...ip capable 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 base ver Description Query product version Property Actions get Command Definition Action Definition get get base ver response val base ver version Parameters Parameter Description version String Firmware bundle version CLI Format Examples get base ver val base ver 1 1 0 212 Supported Products CS700 AV CS700 SP Availabl...

Page 23: ... systemname CS 700 AC 44 F2 11 22 33 set systemname CS 700 MAINCONF notify sys systemname CS 700 MAINCONF Supported Products CS700 AV CS700 SP Available in API Version 1 0 md5 password Description Administrator password for the device stored as MD5 sum Property Actions set Default Value 5735c3a7aa6ffcfe6ab123835584db75 7386 as MD5 sum Command Definition Action Definition set set md5 password passw...

Page 24: ...era 0 1 notify notify sys enable btn camera 0 1 Parameters Parameter Description 0 Disable button 1 Enable button CLI Format Examples get enable btn camera val enable btn camera 1 set enable btn camera 1 notify sys enable btn camera 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 enable btn audio Description Enable disable the microphone mute button on the main unit Property Ac...

Page 25: ... 0 enable btn volume Description Enable disable the speaker volume buttons on the main unit Property Actions set get notify Default Value 1 Command Definition Action Definition get get enable btn volume response val enable btn volume 0 1 set set enable btn volume 0 1 notify notify sys enable btn volume 0 1 Parameters Parameter Description 0 Disable button 1 Enable button CLI Format Examples get en...

Page 26: ... btn bluetooth 0 1 Parameters Parameter Description 0 Disable button 1 Enable button CLI Format Examples get enable btn bluetooth val enable btn bluetooth 1 set enable btn bluetooth 1 notify sys enable btn bluetooth 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 enable led call Description Enable disable the call state LED on the main unit Property Actions set get notify Defau...

Page 27: ...AV CS700 SP Available in API Version 1 0 region Description Region in which device is operating setting by index Property Actions set get notify Default Value 23 Command Definition Action Definition get get region response val region 1 24 set set region 1 24 notify notify sys region 1 24 Parameters Parameter Description 1 Argentina 2 Australia 3 Belgium 4 Brazil 5 Canada 6 Chile 7 China 8 Costa Ri...

Page 28: ...PI Version 1 1 dst enabled Description Enables the system to automatically adjust the time according to the specified Daylight Savings Time DST rules If enabled the DST rules must be provided If disabled the system will not adjust for DST Property Actions set get notify Default Value 1 Command Definition Action Definition get get dst enabled response val dst enabled 0 1 set set dst enabled 0 1 not...

Page 29: ... 2 1 2 Command Definition Action Definition get get dst start rules response val dst start rules start rule set set dst start rules start rule notify notify sys dst start rules start rule Parameters Parameter Description start rule String Format month week day hour CLI Format Examples get dst start rules val dst start rules 3 2 1 2 set dst start rules 3 2 1 2 notify sys dst start rules 3 2 1 2 Sup...

Page 30: ...et dst end rules val dst end rules 11 1 1 2 set dst end rules 11 1 1 2 notify sys dst end rules 11 1 1 2 Supported Products CS700 AV CS700 SP Available in API Version 1 0 time zone Description Time zone setting by index Property Actions set get notify Default Value 13 Command Definition Action Definition get get time zone response val time zone 0 32 set set time zone 0 32 notify notify sys time zo...

Page 31: ... Islamabad 21 5 30 Mumbai 22 5 45 Kathmandu 23 6 00 Dhaka 24 6 30 Yangon 25 7 00 Bangkok 26 8 00 Beijing Hong Kong 27 9 00 Tokyo 28 9 30 Adelaide 29 10 00 Sydney 30 11 00 New Caledonia 31 12 00 Auckland 32 13 00 Nuku alofa CLI Format Examples get time zone val time zone 13 set time zone 13 notify sys time zone 13 Supported Products CS700 AV CS700 SP Available in API Version 1 0 recent call enabled...

Page 32: ...l enabled 1 set recent call enabled 1 notify sys recent call enabled 1 Supported Products CS700 SP Available in API Version 1 1 require https Description Specify if HTTPS is required on Web UI login Property Actions set get notify Default Value 0 Command Definition Action Definition get get require https response val require https 0 1 set set require https 0 1 notify notify sys require https 0 1 P...

Page 33: ...se val power saving mode 0 1 set set power saving mode 0 1 notify notify sys power saving mode 0 1 Parameters Parameter Description 0 Power save mode is off 1 Power save mode is on CLI Format Examples get power saving mode val power saving mode 1 set power saving mode 1 notify sys power saving mode 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 power saving time Description Co...

Page 34: ... 20 notify sys power saving time 20 Supported Products CS700 AV CS700 SP Available in API Version 1 0 auto deploy Description Enable auto provisioning server Property Actions set get notify Default Value 1 Command Definition Action Definition get get auto deploy response val auto deploy 0 1 set set auto deploy 0 1 notify notify sys auto deploy 0 1 Parameters Parameter Description 0 Disable auto di...

Page 35: ...ble deploy 0 1 set set enable deploy 0 1 notify notify sys enable deploy 0 1 Parameters Parameter Description 0 Disable provisioning 1 Enable provisioning CLI Format Examples get enable deploy val enable deploy 1 set enable deploy 1 notify sys enable deploy 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 provisioning interval Description Specify the provisioning interval for th...

Page 36: ...al 1440 set provisioning interval 1440 notify sys provisioning interval 1440 Supported Products CS700 AV CS700 SP Available in API Version 1 0 snmp enable Description Enable or disable SNMP support Property Actions set get notify Default Value 0 Command Definition Action Definition get get snmp enable response val snmp enable 0 1 set set snmp enable 0 1 notify notify sys snmp enable 0 1 Parameters...

Page 37: ...mmunity community set set snmp community community notify notify sys snmp community community Parameters Parameter Description community Read only community string CLI Format Examples get snmp community val snmp community it support set snmp community it support notify sys snmp community it support Supported Products CS700 AV CS700 SP Available in API Version 1 0 snmp contact name Description Spec...

Page 38: ... device location Description Specifies the location of the device for informational purposes Property Actions set get notify Command Definition Action Definition get get snmp device location response val snmp device location location set set snmp device location location notify notify sys snmp device location location Parameters Parameter Description location String Device location CLI Format Exam...

Page 39: ...w the state of dialer connection mode after an action from the dialer or from the CLI Action Current state disconnected Current state ip Current state rc set dialer connection mode disconnected No state change IP dialer disconnection and new state is disconnected New state is disconnected set dialer connection mode rc New state is rc IP dialer disconnection and new state is rc No state change Conn...

Page 40: ...er Description address String IP address or DNS name Leave blank to disable traps CLI Format Examples get snmp address val snmp address 200 200 210 152 set snmp address 200 200 210 152 notify sys snmp address 200 200 210 152 Supported Products CS700 AV CS700 SP Available in API Version 1 0 verbose log enabled Description Enable verbose logging Property Actions set get notify Default Value 0 Comman...

Page 41: ...ler via a bit mask Property Actions set get notify Default Value 0 Command Definition Action Definition get get ui mask response val ui mask bit mask set set ui mask bit mask notify notify sys ui mask bit mask Parameters Parameter Description bit mask 0 All menus are enabled in the dialer 1 For future use value is ignored 2 For future use value is ignored 4 Do not allow modifications of call forwa...

Page 42: ... conn status Description Query USB connection status Property Actions get notify Command Definition Action Definition get get usb conn status response val usb conn status 0 1 notify notify sys usb conn status 0 1 Parameters Parameter Description 0 USB is not connected 1 USB is connected CLI Format Examples get usb conn status val usb conn status 1 notify sys usb conn status 1 Supported Products CS...

Page 43: ...sys upgrade status Flashing Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera upgrade status Description Indicates the camera module upgrade status Property Actions get notify Command Definition Action Definition get get camera upgrade status response val camera upgrade status upgrade status notify notify sys camera upgrade status upgrade status Parameters Parameter Descript...

Page 44: ... status response val power saving status 0 1 notify notify sys power saving status 0 1 Parameters Parameter Description 0 Not in standby 1 In standby CLI Format Examples get power saving status val power saving status 0 notify sys power saving status 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 usb aud rx status Description Query state of USB RX audio stream RX audio being r...

Page 45: ...SB TX audio stream TX audio being sent stopped Property Actions get notify Command Definition Action Definition get get usb aud tx status response val usb aud tx status 0 1 notify notify sys usb aud tx status 0 1 Parameters Parameter Description 0 USB audio TX stream is closed 1 USB audio TX stream is open CLI Format Examples get usb aud tx status val usb aud rx status 1 notify sys usb aud tx stat...

Page 46: ...te restart Parameters None CLI Format Examples restart Supported Products CS700 AV CS700 SP Available in API Version 1 0 set reset setting Description Reset settings by category Command Definition Action Definition execute set reset setting category Parameters Parameter Description all Reset all properties voip Reset VoIP properties audio Reset audio properties network Reset network properties cam...

Page 47: ...ust the speaker frequencies to your preference for the room and the types of calls Property Actions set get notify Default Value 1 Command Definition Action Definition get get eq response val eq 1 2 3 set set eq 1 2 3 notify notify audio eq 1 2 3 Parameters Parameter Description 1 Voice 2 Bass boost 3 Treble boost CLI Format Examples get eq val eq 1 set eq 1 notify audio eq 1 Supported Products CS...

Page 48: ...t get high pass filter response val high pass filter 0 4 set set high pass filter 0 4 notify notify audio high pass filter 0 4 Parameters Parameter Description 0 None 1 110 Hz 2 140 Hz 3 175 Hz 4 225 Hz CLI Format Examples get high pass filter val high pass filter 0 set high pass filter 0 notify audio high pass filter 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 analog audio...

Page 49: ...audio in gain Description For the TV audio in port if analog audio in mode is manual then this is the gain value in dB This value can be increased or decreased by 0 5dB Property Actions set get notify Default Value 4 5 Command Definition Action Definition get get analog audio in gain response val analog audio in gain 12 40 set set analog audio in gain 12 40 notify notify audio analog audio in gain...

Page 50: ...nse val speaker volume 1 18 set set speaker volume 1 18 notify notify audio speaker volume 1 18 Parameters Parameter Description 1 18 Volume setting CLI Format Examples get speaker volume val speaker volume 12 set speaker volume 12 notify audio speaker volume 12 Supported Products CS700 AV CS700 SP Available in API Version 1 0 ring tone Description VoIP ring tone selection Property Actions set get...

Page 51: ...ringer volume Description Configure VoIP ringer volume Property Actions set get notify Default Value 13 Command Definition Action Definition get get ringer volume response val ringer volume 1 18 set set ringer volume 1 18 notify notify audio ringer volume 1 18 Parameters Parameter Description 1 18 Ringer volume level CLI Format Examples get ringer volume val ringer volume 7 set ringer volume 7 not...

Page 52: ... 1 Parameters Parameter Description 0 Speaker is not muted 1 Speaker is muted CLI Format Examples get speaker mute val speaker mute 1 notify audio speaker mute 1 Supported Products CS700 AV CS700 SP Available in API Version 1 1 mute Description Mute microphones Property Actions set get notify Command Definition Action Definition get get mute response val mute 0 1 set set mute 0 1 notify notify aud...

Page 53: ...Description connected External mic is connected disconnected External mic is disconnected CLI Format Examples get mic conn status val mic conn status 1 connected notify audio mic conn status connected Supported Products CS700 AV CS700 SP Available in API Version 1 0 5 2 3 Camera 5 2 3 1 Camera Properties camera ptz home Description Default PTZ settings for home position When the device detects tha...

Page 54: ...Tilt setting default value is 0 1 22 Zoom setting default value is 1 CLI Format Examples get camera ptz home val camera ptz home 0 0 1 set camera ptz home 0 0 1 notify camera camera ptz home 0 0 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera flicker Description Camera s flicker setting Property Actions set get notify Default Value 2 Command Definition Action Definition ...

Page 55: ...faults response val camera image defaults backlight brightness contrast saturation sharpness hue gamma set set camera image defaults backlight brightness contrast saturation sharpness hue gamma notify notify camera camera image defaults backlight brightness contrast saturation sharpness hue gamma Parameters Parameter Description 0 5 Backlight setting 0 250 Brightness setting 60 140 Contrast settin...

Page 56: ...c on Parameters Parameter Description off Camera is off initializing Camera subsystem is initializing upgrading Camera module s firmware is being upgraded reconnecting Camera is coming online unconnected Camera is not connected to USB power_save Camera is in power save mode resync Camera is updating user parameters on Camera is powered on and available for streaming CLI Format Examples get camera ...

Page 57: ... open Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera door Description Query state of camera door Property Actions get notify Command Definition Action Definition get get camera door response val camera door open closed notify notify camera camera door open closed Parameters Parameter Description open Camera privacy door is open closed Camera privacy door is closed CLI For...

Page 58: ...1 Camera video is muted CLI Format Examples get camera mute val camera mute 0 set camera mute 0 notify camera camera mute 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera pan Description Camera s digital pan setting Camera can only be panned when zoomed in Property Actions set get notify Default Value 0 Command Definition Action Definition get get camera pan response val ...

Page 59: ...ult Value 0 Command Definition Action Definition get get camera tilt response val camera tilt 18 18 set set camera tilt 18 18 notify notify camera camera tilt 18 18 Parameters Parameter Description 18 18 Tilt setting CLI Format Examples get camera tilt val camera tilt 0 set camera tilt 0 notify camera camera tilt 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera zoom Descr...

Page 60: ... camera zoom val camera zoom 1 set camera zoom 1 notify camera camera zoom 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 camera backlight Description Backlight compensation for camera Property Actions set get notify Default Value 3 Command Definition Action Definition Get get camera backlight response val camera backlight 0 5 Set set camera backlight 0 5 Notify notify camera ...

Page 61: ... notify Default Value 125 Command Definition Action Definition get get camera brightness response val camera brightness 0 250 set set camera brightness 0 250 notify notify camera camera brightness 0 250 Parameters Parameter Description 0 250 Camera Brightness level CLI Format Examples get camera brightness val camera brightness 125 set camera brightness 125 notify camera camera brightness 125 Supp...

Page 62: ...I Format Examples get camera contrast val camera contrast 110 set camera contrast 110 notify camera camera contrast 110 Supported Products CS700 AV CS700 SP Available in API Version 1 1 camera saturation Description Camera Saturation level Property Actions set get notify Default Value 100 Command Definition Action Definition get get camera saturation response val camera saturation 50 150 set set c...

Page 63: ...ault Value 85 Command Definition Action Definition get get camera sharpness response val camera sharpness 0 255 set set camera sharpness 0 255 notify notify camera camera sharpness 0 255 Parameters Parameter Description 0 255 Camera Sharpness level CLI Format Examples get camera sharpness val camera sharpness 100 set camera sharpness 100 notify camera camera sharpness 100 Supported Products CS700 ...

Page 64: ...mera hue 100 set camera hue 100 notify camera camera hue 100 Supported Products CS700 AV CS700 SP Available in API Version 1 1 camera gamma Description Camera Gamma level Property Actions set get notify Default Value 255 Command Definition Action Definition Get get camera gamma Response val camera gamma 1 255 Set set camera gamma 1 255 Notify notify camera camera gamma 1 255 Parameters Parameter D...

Page 65: ...arameters None CLI Format Examples cam save as default Supported Products CS700 AV CS700 SP Available in API Version 1 0 cam apply defaults Description Apply the camera s default PTZ settings These settings are also automatically applied when the device detects that the upstream USB connection has been established either at startup or after a USB disconnection Command Definition Action Definition ...

Page 66: ...iption Apply the camera s default Backlight Brightness Contrast Saturation Sharpness Hue and Gamma settings These settings are also automatically applied when the device detects that the upstream USB connection has been established either at startup or after a USB disconnection Command Definition Action Definition execute cam image apply defaults Parameters None CLI Format Examples cam image apply...

Page 67: ...om 1 22 Parameters None CLI Format Examples cam zoom out notify camera zoom 1 Supported Products CS700 AV CS700 SP Available in API Version 1 1 cam pan left Description Pan the camera left by one level Command Definition Action Definition Execute cam pan left Notify notify camera pan 30 30 Parameters None CLI Format Examples cam pan left notify camera pan 10 Supported Products CS700 AV CS700 SP Av...

Page 68: ...ommand Definition Action Definition Execute cam tilt up Notify notify camera tilt 18 18 Parameters None CLI Format Examples cam tilt up notify camera tilt 8 Supported Products CS700 AV CS700 SP Available in API Version 1 1 cam tilt down Description Tilt the camera down by one level Command Definition Action Definition Execute cam tilt down Notify notify camera tilt 18 18 Parameters None CLI Format...

Page 69: ...set bt enable 0 1 notify notify bt bt enable 0 1 Parameters Parameter Description 0 Disable 1 Enable CLI Format Examples get bt enable val bt enable 0 set bt enable 0 notify bt bt enable 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 bt mac Description Get the Bluetooth device s MAC address advertised over the air This is read only and set in manufacturing Property Actions get...

Page 70: ...duct name concatenated with the Bluethooth s MAC address i e Yamaha CS 700 last 2 bytes of the Bluetooth s MAC address Command Definition Action Definition get get bt name response val bt name name set set bt name name notify notify bt bt name name Parameters Parameter Description name String Name of device CLI Format Examples get bt name val bt name Yamaha CS 700 22 33 set bt name CS700 MAINCONF ...

Page 71: ... notify bt bt pin 0000 Supported Products CS700 AV CS700 SP Available in API Version 1 0 bt pair timeout Description Bluetooth basic rate pairing timeout in seconds After this time the pairing mode will stop A value of 0 indicates no timeout Property Actions set get notify Default Value 60 Command Definition Action Definition get get bt pair timeout response val bt pair timeout 0 120 set set bt pa...

Page 72: ...itializing Updating Pairing Enabled Connecting Connected notify notify bt bt status Off Initializing Updating Pairing Enabled Connecting Connected Parameters Parameter Description Off Bluetooth is off Initializing Bluetooth subsystem is initializing Updating Bluetooth processor firmware is being upgraded Pairing Bluetooth is in pairing mode Enabled Bluetooth is enabled and on Connecting Bluetooth ...

Page 73: ...31 94 ADR6301 D4 B3 77 EF 31 95 ADR6302 Supported Products CS700 AV CS700 SP Available in API Version 1 0 bt connected Description Get Bluetooth basic rate device connected status If a device is connected returns its MAC address name and profiles Property Actions get notify Command Definition Action Definition get get bt connected response val bt connected mac name notify notify bt bt connected ma...

Page 74: ...r Description 0 Cancel pairing 1 Initiate pairing CLI Format Examples bt pair 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 bt unpair Description Remove all Bluetooth devices in the paired devices list If a device is connected it will be disconnected Command Definition Action Definition Execute bt unpair all Parameters Parameter Description All Remove all paired devices CLI F...

Page 75: ...iption Enable disable NFC and the NFC logo LED on the main unit Property Actions set get notify Default Value 1 Command Definition Action Definition get get nfc enable response val nfc enable 0 1 set set nfc enable 0 1 notify notify bt nfc enable 0 1 Parameters Parameter Description 0 Disable NFC and NFC LED 1 Enable NFC and NFC LED CLI Format Examples get nfc enable val nfc enable 1 set nfc enabl...

Page 76: ...ming VoIP call calling Initiating outgoing VoIP call failed Outgoing call attempt failed it is followed by disconnected when the attempt is disconnected connected Call is connected onhold Call is on hold connected in conf Call is in a conference disconnected Not in a call or phone is not registered update The call is transferred by the far end with some call managers the call state will remain con...

Page 77: ... status all Description Query all call status See call status property for description of status types Property Actions get Command Definition Action Definition get get status all response val status all line1 status1 line2 status2 line3 status3 bt statusbt usb statususb Parameters Parameter Description status1 VoIP line 1 call status status2 VoIP line 2 call status status3 VoIP line 3 call status...

Page 78: ...one number call status Call status as described in the get status parameter description CLI Format Examples get call info 1 val call info 1 Blake 7823 connected Supported Products CS700 AV CS700 SP Available in API Version 1 0 VoIP Available in API Version 1 1 number Description Query a caller number Property Actions get Command Definition Action Definition get get number 1 3 response val number 1...

Page 79: ...tion 1 VoIP line 1 2 VoIP line 2 3 VoIP line 3 used for transfer name Caller s name CLI Format Examples get caller 1 val caller 1 Blake Supported Products CS700 SP Available in API Version 1 1 start time Description Query call start time Return value is in format HH MM SS in 24 hour time Property Actions get Command Definition Action Definition get get start time 1 3 response val start time 1 3 ti...

Page 80: ...tion Definition get get codec 1 3 response val codec 1 3 codec index Parameters Parameter Description 1 VoIP line 1 2 VoIP line 2 3 VoIP line 3 used for transfer codec index 0 5 Codec ID as listed below 0 Disabled 1 G 722 2 G 711U 3 G 711A 4 G729 5 G729 CLI Format Examples get codec 1 val codec 1 2 Supported Products CS700 SP Available in API Version 1 1 call quality Description Query call quality...

Page 81: ...er of lost packets discarded packets Number of discarded packets jitter ms Detected jitter in ms max jitter ms Max detected jitter in ms min jitter ms Min detected jitter in ms buffer level ms Jitter buffer size in ms local ip Local IP address local port Local port number remote ip Remote IP address remote port Remote port number CLI Format Examples get call quality 1 val call quality 1 224 227 35...

Page 82: ...he given call Command Definition Action Definition execute answer 1 2 usb bt Parameters Parameter Description line id 1 2 usb bt Line ID of call to be answered CLI Format Examples answer 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 VoIP Line ID Available in API Version 1 1 hangup Description Hang up the given call Command Definition Action Definition execute hangup 1 3 usb b...

Page 83: ...e id 1 2 usb bt all Line ID of call to be held or hold all lines CLI Format Examples hold 1 Supported Products CS700 AV CS700 SP Available in API Version 1 0 VoIP Line ID Available in API Version 1 1 resume Description Resume the given call Command Definition Action Definition execute resume 1 2 usb bt Parameters Parameter Description line id 1 2 usb bt Line ID of call to be resumed CLI Format Exa...

Page 84: ...0 VoIP Line ID Available in API Version 1 1 join Description Join allows the individual lines to be mixed joined or not mixed separated Used for conferencing existing calls Any line id not specified will default to a mix state of 0 Command Definition Action Definition execute join line id1 mix state line id2 mix_state line id3 mix_state line id4 mix_state Parameters Parameter Description line id1 ...

Page 85: ...te acknowledged transfer After the call has been successfully transferred both lines are released Command Definition Action Definition execute transfer source line id target line id Parameters Parameter Description source line id 1 2 Line ID of call being transferred target line id 3 Line ID of call to which the source will be transferred CLI Format Examples hold 1 dial 3 6175551212 transfer 1 3 S...

Page 86: ...on Definition get get mac response val mac mac address Parameters Parameter Description mac address MAC address CLI Format Examples get mac val mac AC 14 22 01 23 46 Supported Products CS700 AV CS700 SP Available in API Version 1 0 dhcp Description Enables or disables DHCP If DHCP is disabled the Static IP Address Subnet Mask and Default Gateway must be specified Property Actions set get notify De...

Page 87: ...I Version 1 0 ip Description Current IP Address assigned to the device Property Actions set get notify Command Definition Action Definition get get ip response val ip ip address set set ip ip address notify notify net ip ip address Parameters Parameter Description ip address IP address CLI Format Examples get ip val ip 192 168 1 103 set ip 192 168 1 103 notify net ip 192 168 1 103 Supported Produc...

Page 88: ...address CLI Format Examples get subnet val subnet 255 255 255 0 set subnet 255 255 255 0 notify net subnet 255 255 255 0 Supported Products CS700 AV CS700 SP Available in API Version 1 0 gateway Description The Default Gateway is the device s default router on the IP network Property Actions set get notify Command Definition Action Definition get get gateway response val gateway gateway address se...

Page 89: ...t dns1 response val dns1 dns address set set dns1 dns address notify notify net dns1 dns address Parameters Parameter Description dns address String IP address CLI Format Examples get dns1 val dns1 192 168 3 45 set dns1 192 168 3 45 notify net dns1 192 168 3 45 Supported Products CS700 AV CS700 SP Available in API Version 1 0 dns2 Description Address of the secondary Domain Name System DNS server ...

Page 90: ...nd Definition Action Definition get get vlan response val vlan 0 1 2 set set vlan 0 1 2 notify notify net vlan 0 1 2 Parameters Parameter Description 0 Manually specify VLAN ID If the environment uses Voice VLAN but the Voice VLAN ID cannot be detected choose this and specify the ID in the VLAN ID field net vlan id 1 Disable VLAN Switches off VLAN capabilities 2 Automatically detect VLAN ID should...

Page 91: ...inition get get vlan id response val vlan id 1 4094 set set vlan id 1 4094 notify notify net vlan id 1 4094 Parameters Parameter Description 1 4094 VLAN ID CLI Format Examples get vlan id val vlan id 3 set vlan id 3 notify net vlan id 3 Supported Products CS700 AV CS700 SP Available in API Version 1 0 ntp1 Description Configure first NTP Network Time Protocol server address Property Actions set ge...

Page 92: ...API Version 1 0 ntp2 Description Configure second NTP Network Time Protocol server address Property Actions set get notify Default Value 1 pool ntp org Command Definition Action Definition get get ntp2 response val ntp2 ntp address set set ntp2 ntp address notify notify net ntp2 ntp address Parameters Parameter Description ntp address String IP address or URL or DNS name CLI Format Examples get nt...

Page 93: ...eters Parameter Description ntp address String IP address or URL or DNS name CLI Format Examples get ntp3 val ntp3 2 pool ntp org set ntp3 2 pool ntp org notify net ntp3 2 pool ntp org Supported Products CS700 AV CS700 SP Available in API Version 1 0 ntp4 Description Configure fourth NTP Network Time Protocol server address Property Actions set get notify Default Value none Command Definition Acti...

Page 94: ...authentication type and the required credentials also need to be specified MD5 authentication requires a username and password Property Actions set get notify Default Value 0 Command Definition Action Definition get get dot1x enabled response val dot1x enabled 0 1 set set dot1x enabled 0 1 notify notify net dot1x enabled 0 1 Parameters Parameter Description 0 Disable 802 1x authentication 1 Enable...

Page 95: ... username String CLI Format Examples get dot1x identity val dot1x identity testuser set dot1x identity testuser notify net dot1x identity testuser Supported Products CS700 AV CS700 SP Available in API Version 1 0 dot1x password Description Set a 802 1x authentication password required for MD5 Property Actions set get notify Command Definition Action Definition get get dot1x password response val d...

Page 96: ...ny changes to the network settings Command Definition Action Definition execute set net commit Parameters None CLI Format Examples set net commit Supported Products CS700 AV CS700 SP Available in API Version 1 0 5 2 7 VoIP 5 2 7 1 VoIP Properties registrar Description The IP address or DNS name of the SIP registrar server Required for VoIP call support Property Actions set get notify Command Defin...

Page 97: ... inaccessible via UDP or TCP the phone will attempt to register with the backup registrar If the phone successfully registered with the backup registrar it will switch to the backup registrar to perform outgoing calls and receive incoming calls While the phone is registered with the backup registrar it will monitor the primary SIP registrar connection Once the primary SIP registrar becomes availab...

Page 98: ...m response val realm realm set set realm realm notify notify voip realm realm Parameters Parameter Description realm Realm string CLI Format Examples get realm val realm set realm notify voip realm Supported Products CS700 SP Available in API Version 1 1 proxy Description The outbound SIP proxy server s IP address or name If there are multiple SIP proxies separate the addresses by a comma Also not...

Page 99: ...ts CS700 SP Available in API Version 1 1 reg use proxy Description Indicates whether the SIP proxy server s specified in proxy property should be used when registering Selecting this option will add the listed proxy server s to the route headers of the SIP REGISTER request Property Actions set get notify Default Value 0 Command Definition Action Definition get get reg use proxy response val reg us...

Page 100: ...se val user user name set set user user name notify notify voip user user name Parameters Parameter Description user name String SIP username CLI Format Examples get user val user testuser set user testuser notify voip user testuser Supported Products CS700 SP Available in API Version 1 1 password Description SIP password for the account used to authenticate with the SIP registrar and proxies Requ...

Page 101: ...ailable in API Version 1 1 id Description SIP ID used for SIP registration If this field is left blank the voip user User name field will be used as the ID Property Actions set get notify Command Definition Action Definition get get id response val id id set set id id notify notify voip id id Parameters Parameter Description id String SIP ID CLI Format Examples get id val id 7824 set id 7824 notif...

Page 102: ...l name name set set name name notify notify voip name name Parameters Parameter Description name String VoIP Display Name CLI Format Examples get name val name Blake set name Blake notify voip name Blake Supported Products CS700 SP Available in API Version 1 1 reg timeout Description Registration Timeout is the optional timeout for SIP account registration in seconds Property Actions set get notif...

Page 103: ... Actions set get notify Default Value 300 Command Definition Action Definition get get rereg delay response val rereg delay 1 604800 set set rereg delay 1 604800 notify notify voip rereg delay 1 604800 Parameters Parameter Description 1 604800 Auto re registration retry interval in seconds CLI Format Examples get rereg delay val rereg delay 300 set rereg delay 300 notify voip rereg delay 300 Suppo...

Page 104: ...the remote supports and uses it 2 Mandatory Session Timers support will be a requirement for the remote to be able to establish a session 3 Always Session Timers will always be used in all sessions regardless whether the remote supports or uses it or not CLI Format Examples get use timer val use timer 1 set use timer 1 notify voip use timer 1 Supported Products CS700 SP Available in API Version 1 ...

Page 105: ...ssion timer minimal expiration period seconds This is the minimum period that the device will accept when negotiating the expiration period with the remote phone If the session timer expiration duration is less than this value this value is used instead It is measured in seconds Property Actions set get notify Default Value 90 Command Definition Action Definition get get timer min se response val ...

Page 106: ... to add the PRACK provisional ACK message support for reliability Property Actions set get notify Default Value 0 Command Definition Action Definition get get use 100rel response val use 100rel 0 1 set set use 100rel 0 1 notify notify voip use 100rel 0 1 Parameters Parameter Description 0 Disable reliable provisional responses 1 Enable reliable provisional responses CLI Format Examples get use 100...

Page 107: ...get auto update nat response val auto update nat 0 1 set set auto update nat 0 1 notify notify voip auto update nat 0 1 Parameters Parameter Description 0 Disable NAT 1 Enable NAT CLI Format Examples get auto update nat val auto update nat 1 set auto update nat 1 notify voip auto update nat 1 Supported Products CS700 SP Available in API Version 1 1 dtmf method Description DTMF signaling method Pro...

Page 108: ...et get dtmf rtp payload type response val dtmf rtp payload type 96 127 set set dtmf rtp payload type 96 127 notify notify voip dtmf rtp payload type 96 127 Parameters Parameter Description 96 127 RTP packet type CLI Format Examples get dtmf rtp payload type val dtmf rtp payload type 96 set dtmf rtp payload type 0 notify voip dtmf rtp payload type 0 Supported Products CS700 SP Available in API Vers...

Page 109: ... RFC2543 Implements the functionality according to RFC2543 In the INVITE message SDP body the connection line ip is set to 0 0 0 0 e g c IN IP4 0 0 0 0 and the attribute a inactive is added CLI Format Examples get media onhold method val media onhold method 0 set media onhold method 0 notify voip media onhold method 0 Supported Products CS700 SP Available in API Version 1 1 use srtp Description Co...

Page 110: ...SP Available in API Version 1 1 rtp port Description Base port number for VoIP RTP RTP is originated and received on even port numbers and the associated RTCP uses the next higher odd port number Property Actions set get notify Default Value 4000 Command Definition Action Definition get get rtp port response val rtp port 1024 65535 set set rtp port 1024 65535 notify notify voip rtp port 1024 65535...

Page 111: ...inition Action Definition get get set qos response val set qos 0 1 set set set qos 0 1 notify notify voip set qos 0 1 Parameters Parameter Description 0 Disable QoS 1 Enable QoS CLI Format Examples get set qos val set qos 0 set set qos 0 notify voip set qos 0 Supported Products CS700 SP Available in API Version 1 1 udp tcp selection Description Transport that will be used for SIP messages Property...

Page 112: ...ription Specifies the local port for SIP transport Property Actions set get notify Default Value 5060 Command Definition Action Definition get get local port response val local port 1024 65535 set set local port 1024 65535 notify notify voip local port 1024 65535 Parameters Parameter Description 1024 65535 Port number CLI Format Examples get local port val local port 5060 set local port 5060 notif...

Page 113: ...Description ip address IP address CLI Format Examples get ip addr val ip addr 192 168 1 103 set ip addr 192 168 1 103 notify voip ip addr 192 168 1 103 Supported Products CS700 SP Available in API Version 1 1 bound addr Description Optional address where the socket should be bound to This option should only be used to selectively bind the socket to a particular interface and should not be used to ...

Page 114: ...sfer about the receiver s status in handling the REFER In some cases these event subscriptions and notifications are not needed such as when forking is not used Enable this option to suppress the automatic event subscriptions when transferring calls Property Actions set get notify Default Value 0 Command Definition Action Definition get get no refer sub response val no refer sub 0 1 set set no ref...

Page 115: ...fy notify voip min size 0 1 Parameters Parameter Description 0 Do not use compact format 1 Use compact format CLI Format Examples get min size val min size 0 set min size 0 notify voip min size 0 Supported Products CS700 SP Available in API Version 1 1 allow strict Description Allow strict routing for SIP registration proxies By default proxies specified for SIP registration will be configured as ...

Page 116: ...ecifies the STUN Session Traversal Utilities for NAT server IP address or name to use to determine if the phone is behind a NAT the type of NAT and the public address of the phone The field can contain a comma separated list of servers Each server can be a domain name host name or IP address and it may contain an optional port number For STUN see IETF RFC 5389 Property Actions set get notify Comma...

Page 117: ...fy candidates IP addresses and ports for communication evaluating and prioritizing the candidate pairs to select the best route Expensive candidates such as using a media relay are selected only as a last resort For ICE see IETF RFC 5245 Property Actions set get notify Default Value 0 Command Definition Action Definition get get use ice response val use ice 0 1 set set use ice 0 1 notify notify vo...

Page 118: ...indicating that the pair is nominated 1 Aggressive nomination method CS 700 does not wait to set the nominated flag in a second STUN binding request but rather sets the flag in the STUN binding requests for all of the candidate pairs The ICE processing completes when the first pair successfully passes connectivity checks The aggressive method is faster but does not always result in the optimal pat...

Page 119: ...t Examples get ice max hosts val ice max hosts 5 set ice max hosts 5 notify voip ice max hosts 5 Supported Products CS700 SP Available in API Version 1 1 ice no rtcp Description Option to not disable the RTCP component in ICE Property Actions set get notify Default Value 0 Command Definition Action Definition Get get ice no rtcp Response val ice no rtcp 0 1 Set set ice no rtcp 0 1 Notify notify vo...

Page 120: ...TURN relays are used when other preferred mechanisms are not available such as STUN or direct connectivity If TURN is enabled the other TURN settings server username and password must also be specified Property Actions set get notify Default Value 0 Command Definition Action Definition Get get use turn Response val use turn 0 1 Set set use turn 0 1 Notify notify voip use turn 0 1 Parameters Parame...

Page 121: ...rmat is either DOMAIN PORT or HOST PORT CLI Format Examples get turn srv val turn srv 200 200 210 153 5349 set turn srv 200 200 210 153 5349 notify voip turn srv 200 200 210 153 5349 Supported Products CS700 SP Available in API Version 1 1 turn user Description Username to authenticate against the TURN server Property Actions set get notify Command Definition Action Definition Get get turn user Re...

Page 122: ...n passwd Response val turn passwd password Set set turn passwd password Notify notify voip turn passwd password Parameters Parameter Description Password String CLI Format Examples get turn passwd val turn passwd 1234 set turn passwd 1234 notify voip turn passwd 1234 Supported Products CS700 SP Available in API Version 1 1 turn tcp Description Configure whether to use TCP on TURN relay otherwise u...

Page 123: ...CS700 SP Available in API Version 1 1 codec1 Description Highest prioritized codec At least one codec different from None has to be selected in voip codec1 voip codec5 Property Actions set get notify Default Value 1 Command Definition Action Definition Get get codec1 Response val codec1 0 5 Set set codec1 0 5 Notify notify voip codec1 0 5 Parameters Parameter Description 0 None 1 G 722 2 G 711 u l...

Page 124: ...ify Default Value 2 Command Definition Action Definition Get get codec2 Response val codec2 0 5 Set set codec2 0 5 Notify notify voip codec2 0 5 Parameters Parameter Description 0 None 1 G 722 2 G 711 u law PCMU 3 G 711 A law PCMA 4 G 726 5 G 729 CLI Format Examples get codec2 val codec2 2 set codec2 2 notify voip codec2 2 Supported Products CS700 SP Available in API Version 1 1 codec3 Description...

Page 125: ...CMU 3 G 711 A law PCMA 4 G 726 5 G 729 CLI Format Examples get codec3 val codec3 3 set codec3 3 notify voip codec3 3 Supported Products CS700 SP Available in API Version 1 1 codec4 Description Fourth highest prioritized codec At least one codec different from None has to be selected in voip codec1 voip codec5 Property Actions set get notify Default Value 4 Command Definition Action Definition get ...

Page 126: ...P Available in API Version 1 1 codec5 Description Lowest prioritized codec At least one codec different from None has to be selected in voip codec1 voip codec5 Property Actions set get notify Default Value 5 Command Definition Action Definition get get codec5 response val codec5 0 5 set set codec5 0 5 notify notify voip codec5 0 5 Parameters Parameter Description 0 None 1 G 722 2 G 711 u law PCMU ...

Page 127: ...finition Action Definition get get ptime response val ptime 10 60 set set ptime 10 60 notify notify voip ptime 10 60 Parameters Parameter Description 10 60 ptime interval in 10 ms increments CLI Format Examples get ptime val ptime 20 set ptime 20 notify voip ptime 20 Supported Products CS700 SP Available in API Version 1 1 mwi Description Enable displaying the message waiting indicator MWI on the ...

Page 128: ... mwi 0 set mwi 0 notify voip mwi 0 Supported Products CS700 SP Available in API Version 1 1 vm number Description The number that is dialed when voicemail is called from the UI Property Actions set get notify Command Definition Action Definition get get vm number response val vm number vm number set set vm number vm number notify notify voip vm number vm number Parameters Parameter Description vm ...

Page 129: ...fy notify voip vm count vm count Parameters Parameter Description vm count Number of VoIP voice mail messages CLI Format Examples get vm count val vm count 2 notify voip vm count 2 Supported Products CS700 SP Available in API Version 1 1 do not disturb Description Configure do not disturb DND setting Property Actions set get notify Default Value 0 Command Definition Action Definition get get do no...

Page 130: ... are no available lines the Forward rules will apply If there are no Forward rules specified the incoming call will be sent to voice mail If voice mail is not supported the call will be rejected Property Actions set get notify Default Value 0 Command Definition Action Definition get get auto answer response val auto answer 0 100 699 set set auto answer 0 100 699 notify notify voip auto answer 0 10...

Page 131: ...0 10080 notify notify voip duration 0 10080 Parameters Parameter Description 0 No maximum 1 10080 Maximum VoIP call duration in minutes CLI Format Examples get duration val duration 0 set duration 0 notify voip duration 0 Supported Products CS700 SP Available in API Version 1 1 dial plan Description Specifies the VoIP dial plan string See the User s Guide for a detailed description of dial plan se...

Page 132: ...9 xx 2 9 xxxxxx Supported Products CS700 SP Available in API Version 1 1 always forwarding Description Enable or disable forwarding all incoming VoIP calls to the specified number Property Actions set get notify Default Value 0 Command Definition Action Definition get get always forwarding response val always forwarding 0 1 set set always forwarding 0 1 notify notify voip always forwarding 0 1 Par...

Page 133: ... String VoIP dialing number CLI Format Examples get always forwarding num val always forwarding num 7823 set always forwarding num 7823 notify voip always forwarding num 7823 Supported Products CS700 SP Available in API Version 1 1 busy forwarding Description Enable or disable forwarding incoming calls to the specified number if the local phone is in Do Not Disturb mode or if both lines are busy P...

Page 134: ...efinition Action Definition get get busy forwarding num response val busy forwarding num fwd number set set busy forwarding num fwd number notify notify voip busy forwarding num fwd number Parameters Parameter Description fwd number String VoIP dialing number CLI Format Examples get busy forwarding num val busy forwarding num 7823 set busy forwarding num 7823 notify voip busy forwarding num 7823 S...

Page 135: ...swer forwarding 0 notify voip noanswer forwarding 0 Supported Products CS700 SP Available in API Version 1 1 noanswer forwarding num Description Forward incoming VoIP calls to the specified number if the call is not answered within the duration specified in the noanswer delay attribute Property Actions set get notify Command Definition Action Definition get get noanswer forwarding num response val...

Page 136: ...noanswer forwarding num number Property Actions set get notify Default Value 10 Command Definition Action Definition get get noanswer delay response val noanswer delay 2 30 set set noanswer delay 2 30 notify notify voip noanswer delay 2 30 Parameters Parameter Description 2 30 Seconds to wait before forwarding a call CLI Format Examples get noanswer delay val noanswer delay 10 set noanswer delay 1...

Page 137: ...an above Registration attempt failed CLI Format Examples get registration val registration 999 notify voip registration 200 Supported Products CS700 SP Available in API Version 1 1 5 2 7 3 VoIP Commands set dtmf Description Send DTMF digit on given VoIP line during an active call Command Definition Action Definition execute set dtmf voip line id digit Parameters Parameter Description 1 VoIP line 1...

Page 138: ...ese files can also specify a firmware upgrade bundle and version information When a device starts it sends a request to the DHCP server for an IP address In addition to the IP address the device can query the DHCP server for additional information configured on the DHCP server Options 66 and 150 provide the address or hostname of one or more HTTP TFTP or FTP servers A TFTP server needs to be confi...

Page 139: ...s in xml format The syntax of the file is provisioning include comma separated list of include files config list of config parameters firmware version firmware version firmware file name firmware provisioning where indicates an optional parameter and indicate a description of the content to be provided The config tag contains all configuration settings that pertain to the device while the firmware...

Page 140: ...ys md5 password TEXT Password string 7386 as MD5 sum see command Administrator password for the device stored as MD5 sum sys enable btn camera BOOLEAN 0 Disable button 1 Enable button 1 Enable disable the camera button on the main unit sys enable btn audio BOOLEAN 0 Disable button 1 Enable button 1 Enable disable the microphone mute button on the main unit sys enable btn volume BOOLEAN 0 Disable b...

Page 141: ...ccording to the specified Daylight Savings Time DST rules If enabled the DST rules must be provided If disabled the system will not adjust for DST sys dst start rules TEXT String format month week day hour 3 2 1 2 Indicates the month week day Sunday 1 Saturday 7 and hour when daylight savings time starts A week value of 5 indicates the last week of the month The default is the US DST rule of the s...

Page 142: ...00 Abu Dhabi 19 4 30 Kabul 20 5 00 Islamabad 21 5 30 Mumbai 22 5 45 Kathmandu 23 6 00 Dhaka 24 6 30 Yangon 25 7 00 Bangkok 26 8 00 Beijing Hong Kong 27 9 00 Tokyo 28 9 30 Adelaide 29 10 00 Sydney 30 11 00 New Caledonia 31 12 00 Auckland 32 13 00 Nuku alofa 13 Time zone setting by index sys require https BOOLEAN 0 Do not require HTTPS 1 Require HTTPS 0 Configure require https setting sys power savi...

Page 143: ...s the contact name typically the system administrator This string is informational and can include an email address It is not associated with traps sys snmp device location TEXT Device location Specifies the location of the device for informational purposes sys snmp address TEXT IP address or DNS name Specifies SNMP server address to which traps will be sent Leave blank to disable traps sys recent...

Page 144: ...V audio in port select the gain setting mode either auto or manual audio analog audio in gain NUMBER 12 0 40 0 Manual gain setting 4 5 For the TV audio in port if analog audio in mode is manual then this is the gain value in dB This value can be increased or decreased by 0 5dB audio ring tone INDEXED_ OPTION 0 5 Ring tone index 0 VoIP ring tone selection audio ringer volume TEXT 1 18 Ringer volume...

Page 145: ... pin TEXT pin 4 digit string 0000 The Bluetooth basic rate pin for pairing Pins are 4 digits bt bt pair timeout NUMBER 0 No timeout 1 120 Pairing timeout in seconds 60 Bluetooth basic rate pairing timeout in seconds After this time the pairing mode will stop bt nfc enable BOOLEAN 0 Disable NFC and NFC LED 1 Enable NFC and NFC LED 1 Enable disable NFC and the NFC logo LED on the main unit net dhcp ...

Page 146: ...rg Configure first NTP Network Time Protocol server address net ntp2 TEXT IP address or URL or DNS name 1 pool ntp org Configure second NTP Network Time Protocol server address net ntp3 TEXT IP address or URL or DNS name 2 pool ntp org Configure third NTP Network Time Protocol server address net ntp4 TEXT IP address or URL or DNS name Configure fourth NTP Network Time Protocol server address net d...

Page 147: ...uthenticate or Proxy Authenticate header in the 401 407 response An asterisk causes the endpoint to respond to any realms voip proxy TEXT IP address or name Separate multiple addresses by a comma Add lr suffix for loose routing The outbound SIP proxy server s IP address or name If there are multiple SIP proxies separate the addresses by a comma Also note that if the allow strict routing option is ...

Page 148: ... an outbound call is made If no Display Name is provided the User name will be used Please note that the IP PBX might override the Display name sent by the device and replace it with names configured in the PBX voip reg timeout NUMBER 1 604800 Registration timeout in seconds 60 Registration Timeout is the optional timeout for SIP account registration in seconds voip rereg delay NUMBER 1 604800 Aut...

Page 149: ...te phone If the session timer expiration duration is less than this value this value is used instead It is measured in seconds voip use 100rel BOOLEAN 0 Disable reliable provisional responses 1 Enable reliable provisional responses 0 Implements reliable SIP provisional responses SIP is a request response type of protocol with two types of responses provisional and final Final responses are sent re...

Page 150: ...nt Contact update the Contact with the transport address obtained from the Via header and register a new Contact to the SIP registrar This option will also update the public name of the UDP transport if STUN is configured voip dtmf method TEXT 0 RTP RFC2833 1 SIP INFO 2 In band 0 DTMF signaling method voip dtmf rtp payload type TEXT 96 127 96 Specify the dynamic RTP payload type for DTMF transport...

Page 151: ...Option to enable QoS Quality of Service tagging for SIP and media For layer 3 at the Internet layer the DiffServ Differentiated Services precedence level is Class 3 The Differentiated Services Code Point DSCP in the IP header is set to 24 0x18 For layer 2 IEEE 802 1p tagging is supported voip udp tcp selection BOOLEAN 0 UDP 1 TCP 0 Transport that will be used for SIP messages voip local port NUMBE...

Page 152: ...Enable this option to suppress the automatic event subscriptions when transferring calls See IETF RFC 4488 voip min size BOOLEAN 0 Do not use compact format 1 Use compact format 0 Use compact SIP message format The SIP protocol specifies that header field names can be in the full name form or in the abbreviated form Abbreviated form is useful when messages might be too large to be carried on the a...

Page 153: ...ng strict routing proxies If this option is enabled and you are specifying one or more loose routing proxies in the Proxy field then you must manually add the suffix to each loose routing proxy address For example 10 134 123 101 lr voip stun srv TEXT stun address String IP address domain name or host name and optional port number Separate multiple addresses by comma Specifies the STUN Session Trav...

Page 154: ...rred ICE Nomination Method To validate candidate pairs IP addresses and ports for the local and remote nodes CS 700 sends STUN binding requests as part of the media connectivity tests When a candidate is nominated for use a STUN binding request is sent with a flag indicating that the candidate pair is nominated voip ice max hosts NUMBER 0 No maximum 1 10 Maximum number of host candidates 5 Maximum...

Page 155: ...g The format is either DOMAIN PORT or HOST PORT TURN server domain name or hostname and port The format is either DOMAIN PORT or HOST PORT voip turn user TEXT User name Username to authenticate against the TURN server voip turn passwd TEXT Password Password to authenticate against the TURN server voip turn tcp BOOLEAN 0 Do not use TCP use UDP 1 Use TCP 0 Configure whether to use TCP on TURN relay ...

Page 156: ...one codec different from None has to be selected in voip codec1 voip codec5 voip ptime NUMBER 10 60 ptime interval in ms 20 The ptime packetization interval value for a codec determines the length of time in milliseconds represented by the media in an RTP packet which is used to transmit audio traffic voip mwi BOOLEAN 0 Disable MWI signaling 1 Enable MWI signaling 0 Enable displaying the message w...

Page 157: ...l plan string Specifies the VoIP dial plan string See the User s Guide for a detailed description of dial plan settings voip always forwarding BOOLEAN 0 Disable 1 Enable 0 Enable or disable forwarding all incoming VoIP calls to the specified number voip always forwarding num TEXT VoIP dialing number Forward all incoming VoIP calls to the specified number voip busy forwarding BOOLEAN 0 Disable 1 En...

Page 158: ...bled 1 means that SNMP is available snmp address Specifies SNMP server address to which traps will be sent Leave blank to disable traps snmp community Specifies the SNMP read only community string used for queries from the server and transmitted traps Read only indicates the authorization level The device does not support write operations initiated through SNMP snmp contact name Specifies the cont...

Page 159: ...tions 144 North Rd Sudbury MA 01776 email uc customersupport music yamaha com DESCRIPTION Defines monitoring structures for the Yamaha SNMP agent for CS 700 REVISION 201710010000Z DESCRIPTION Initial revision enterprises 1182 cs700 OBJECT IDENTIFIER yamahaAgentMIB 7386 cs700Traps OBJECT IDENTIFIER cs700 1 cs700TrapsObjects OBJECT IDENTIFIER cs700Traps 1 CS 700 objects serial OBJECT TYPE SYNTAX Dis...

Page 160: ...eaker audio stream active 0 1 of type String cs700 15 usbVidStream OBJECT TYPE SYNTAX DisplayString MAX ACCESS read only STATUS current DESCRIPTION USB video stream active 0 1 of type String cs700 16 btConnected OBJECT TYPE SYNTAX DisplayString MAX ACCESS read only STATUS current DESCRIPTION Bluetooth connection active 0 1 of type String cs700 17 voipCallStatus OBJECT TYPE SYNTAX DisplayString MAX...

Page 161: ...maha CS 700 Integrators Reference Guide 161 cs700TrapsObjects 1 usbConnTrapHit NOTIFICATION TYPE OBJECTS usbconnTrap STATUS current DESCRIPTION Generated when USB connection state changes cs700Traps 1 END ...

Page 162: ...ide 162 Appendix A Volume Mappings The table below identifies the volume mapping between the CS 700 device and the host operating systems Windows 7 and 8 are shown in column W7 Windows 10 is column W10 Mac and Chrome are shown in column MAC ...

Page 163: ...nection mode rc 4 Crestron device must issue get registration and receive a reply val registration 200 before attempting SIP calls Note that on a power up CS 700 will come up un registered with SIP server SIP registration procedure begins when the Crestron device issues set dialer connection mode rc command in the steps above The following examples show how a typical dialer state machine will cont...

Page 164: ... Similarly a single line cannot be left in a conference with the join command Commands join 1 1 2 0 and join 1 0 2 1 will also remove both calls from the conference Similarly if no calls are in the conference join 1 1 2 0 does not change the line 1 status to indicate that it s in conference If no calls are in the conference join 1 0 2 1 does not change the line 2 status to indicate that it s in co...

Page 165: ...d SIP line 2 is in active state The user may now initiate a conference Note held calls cannot be added in a conference resume 1 resume usb join 1 1 2 1 usb 1 At this point all calls USB line 1 and line 2 are in a conference Hold only one call Starting from the previous example the user puts line 1 on hold hold 1 Because a held call cannot be in conference this automatically removes line 1 from the...

Page 166: ...is point line 1 and USB are in conference and line 2 is on hold outside the conference The user now puts line 2 in conference resume 2 At this point line 2 and the conference are in active state join 1 1 2 1 usb 1 At this point all lines are in active state in the conference Hangup a call in conference The user starts with line 1 and USB in an active conference hangup 1 At this point line1 is disc...

Search results

Summary of Contents for CS-700 Series

Reviews:

Related manuals for CS-700 Series

Brands by name

Popular brands

Yamaha CS-700 Series, Integrators Reference Manual

Search results

Summary of Contents for CS-700 Series

Reviews:

Related manuals for CS-700 Series

Brands by name

Popular brands