Yamaha CS-700 Series Integrators Reference Manual
  1. Manuals
  2. Brands
  3. Yamaha Manuals
  4. Conference System
  5. CS-700 Series
  6. Integrators reference manual

Yamaha CS-700 Series Integrators Reference Manual

Hide thumbs Also See for CS-700 Series:
Table of Contents

Advertisement

Quick Links

See also: Operating Manual
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

Advertisement

Table of Contents
loading

Related Manuals for Yamaha CS-700 Series

Summary of Contents for Yamaha 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: Table Of Contents

    API Command Reference ........................19 Overview ............................. 19 Categories ........................... 20 5.2.1 System ..........................20 5.2.1.1 System Properties ......................20 product ............................20 base-sernum ..........................21 voip-capable ..........................21 base-ver ............................22 systemname ..........................22 md5-password ..........................23 Yamaha CS-700 Integrators Reference Guide...
  • Page 3 System Commands ......................45 regnotify ............................45 restart ............................46 set reset-setting .......................... 46 5.2.2 Audio ........................... 47 5.2.2.1 Audio Properties ......................47 eq ..............................47 high-pass-filter ..........................47 analog-audio-in-mode ......................... 48 analog-audio-in-gain ........................49 speaker-volume .......................... 50 Yamaha CS-700 Integrators Reference Guide...
  • Page 4 ..........................66 cam-zoom-out ..........................67 cam-pan-left ..........................67 cam-pan-right ..........................67 cam-tilt-up ........................... 68 cam-tilt-down ..........................68 5.2.4 Bluetooth ..........................69 5.2.4.1 Bluetooth Properties ....................... 69 bt-enable ............................. 69 bt-mac ............................69 bt-name ............................70 Yamaha CS-700 Integrators Reference Guide...
  • Page 5 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-id ............................91 Yamaha CS-700 Integrators Reference Guide...
  • Page 6 ............................110 set-qos ............................110 udp-tcp-selection ........................111 local-port ........................... 112 ip-addr ............................112 bound-addr ..........................113 no-refer-sub ..........................114 min-size ............................. 115 allow-strict ..........................115 stun-srv ............................. 116 use-ice ............................117 ice-regular ..........................118 Yamaha CS-700 Integrators Reference Guide...
  • Page 7 ............................. 137 set voip-commit ........................138 Provisioning ............................138 Provisioning Files ........................139 Provisioning File Parameters ..................... 140 SNMP ..............................158 Appendix A – Volume Mappings ....................... 162 Appendix B – Crestron Integration TCP/IP ....................163 Yamaha CS-700 Integrators Reference Guide...

  • Page 8: Overview

    1 Overview The Yamaha CS-700 provides standard USB 3.0 and USB 2.0 communication links to a host processor (PC). It also provides an IP interface for management and VoIP calling. This guide describes the interfaces that hosts and external clients can use to manage and monitor the CS-700.

  • Page 9: 2.1 Vid And Pid

    ID 5: IN/OUT, Skype Reports, (Mute, Hook, Flash) IN; (Mute, Hook, Ring, Hold) OUT ID 6: OUT, Custom Audio Settings, (Room Properties), size 8, count 7 (OUT) • Interface 4; BULK: ep7 (IN), ep8 (OUT), 64 bytes (Upgrade) 2.3.1 Audio Report Description Endpoint/ Report Notes Report ID Value Yamaha CS-700 Integrators Reference Guide...

  • Page 10: Speaker Volume Synchronization

    Room Property Parameters (4) #People, EQ, MicHP, Reverb (Currently unused in Cannonball) 2.3.2 Speaker Volume Synchronization The speaker volume can be controlled from the device by using the volume up/down cap-touch buttons on the base unit. Yamaha CS-700 Integrators Reference Guide...

  • Page 11: 2.4 Interface Definitions For The Camera Component

    VC_INPUT_TERMINAL descriptor and VC_PROCESSING_UNIT descriptor will set the appropriate flags for the parameters is supports. It will also define an endpoint for interrupt support to report local changes back to the host. Description Report Value Notes Video Control ID ep0/4 Yamaha CS-700 Integrators Reference Guide...

  • Page 12: Video Stream

    Note: The CS-700 video camera only supports uncompressed video formats, which limits the resolution in USB 2.0. * Skype 2.0: Skype and Lync Video Capture Specification (Doc # H100693) Skype 3.0: Skype for Business Video Capture Specification (Doc # H100693) Yamaha CS-700 Integrators Reference Guide...

  • Page 13: Ip Interface

    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 is roomcontrol and the password is Yamaha-CS- 700, both case sensitive. The port number is the standard Telnet port 23. If it is required to see the API commands echoed back to the telnet client, execute “set echo 1”...

  • Page 14: Echo

    The API commands are described in section 5, API Command Reference. If the host is connected directly to the device via USB, then a client application can communicate via the USB interface. The Library interface is described below. Yamaha CS-700 Integrators Reference Guide...

  • Page 15: 4.1 Usb Library Reference

    Pointer to callback function to handle events. event_callback Type of event as listed in table below. Type Return Values: Value Description General error Success No device connected Failed authentication Event Types: Type Description 0xFF Device disconnected Yamaha CS-700 Integrators Reference Guide...

  • Page 16: Devdetach

    Send a CLI-format command to the device. The commands are defined in in section 5, Command Reference. Syntax: EXPORT int __cdecl coreCliCmd(char *cmd, char *rsp, int len); Parameters: Parameter Description CLI command string (see API Command Reference) Pointer to response string Bytes available in response string Yamaha CS-700 Integrators Reference Guide...

  • Page 17: Notifctrl

    Parameters: Parameter Description bundle Complete file path of upgrade bundle update_firmware_ Pointer to callback function to handle upgrade progress notifications callback_t nPercent Callback function parameter: Percent completion. A value of -1 indicates an upgrade error. Yamaha CS-700 Integrators Reference Guide...

  • Page 18: Downloadlogs

    *filepath)); Parameters: Parameter Description configFile Complete file path of config file import_config_ Pointer to callback function to handle import progress notifications callback_t nPercent Callback function parameter: Percent completion. A value of -1 indicates an import Yamaha CS-700 Integrators Reference Guide...

  • Page 19: Exportconfig

    The API is organized by functional Category, such as Audio and Camera, and within each category are listed the properties, status items and commands that are available for that category. Notifications are identified with their corresponding property or status item. Yamaha CS-700 Integrators Reference Guide...

  • Page 20: Categories

    Changes to properties in the VoIP group must be applied by the voip-commit command. See Appendix B – Crestron Integration TCP/IP for re-registration sequence with the SIP server. 5.2.1 System 5.2.1.1 System Properties product Description: Product name. Read-only set at manufacturing. Property Actions: Yamaha CS-700 Integrators Reference Guide...

  • Page 21: Base-Sernum

    CSS701000062 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 voip-capable Description: Is VoIP supported on the device. This capability is set at the factory and cannot be changed. Property Actions: Yamaha CS-700 Integrators Reference Guide...

  • Page 22: 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 Available in API Version: 1.0 systemname Description: Specifies the system name. Yamaha CS-700 Integrators Reference Guide...

  • Page 23: Md5-Password

    Default Value: 5735c3a7aa6ffcfe6ab123835584db75 (7386 as MD5 sum) Command Definition: Action Definition set md5-password <"password"> notify notify sys.md5-password <"password"> Parameters: Parameter Description password Password string as MD5 sum (32 hexadecimal numbers) CLI Format Examples: set md5-password 5735c3a7aa6ffcfe6ab123835584db75 Yamaha CS-700 Integrators Reference Guide...

  • Page 24: Enable-Btn-Camera

    Available in API Version: 1.0 enable-btn-audio Description: Enable/disable the microphone mute button on the main unit. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get enable-btn-audio response val enable-btn-audio <0|1> set enable-btn-audio <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 25: Enable-Btn-Volume

    <0|1> set enable-btn-volume <0|1> notify notify sys.enable-btn-volume <0|1> Parameters: Parameter Description Disable button Enable button CLI Format Examples: get enable-btn-volume val enable-btn-volume 1 set enable-btn-volume 1 notify sys.enable-btn-volume 1 Supported Products: CS700-AV, CS700-SP Yamaha CS-700 Integrators Reference Guide...

  • Page 26: Enable-Btn-Bluetooth

    Description: Enable/disable the call state LED on the main unit. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get enable-led-call response val enable-led-call <0|1> set enable-led-call <0|1> notify notify sys.enable-led-call <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 27: Region

    Default Value: Command Definition: Action Definition get region response val region <1..24> set region <1..24> notify notify sys.region <1..24> Parameters: Parameter Description Argentina Australia Belgium Brazil Canada Chile China Costa Rica France Germany Hong Kong India Yamaha CS-700 Integrators Reference Guide...

  • Page 28: Dst-Enabled

    DST. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get dst-enabled response val dst-enabled <0|1> set dst-enabled <0|1> notify notify sys.dst-enabled <0|1> Parameters: Parameter Description Disable DST Enable DST CLI Format Examples: Yamaha CS-700 Integrators Reference Guide...

  • Page 29: Dst-Start-Rules

    Indicates the month, week, day (Sunday = 1, Saturday = 7) and hour that daylight savings time ends. The default is the US DST rule of the first Sunday in November at 2 AM. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 30: Time-Zone

    Default Value: Command Definition: Action Definition get time-zone response val time-zone <0..32> set time-zone <0..32> notify notify sys.time-zone <0..32> Parameters: Parameter Description -11:00 American Samoa -10:00 Hawaii -9:00 Alaska -8:00 Pacific Time -7:00 Mountain Time Yamaha CS-700 Integrators Reference Guide...

  • Page 31: Recent-Call-Enabled

    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 Description: Enables or disable the Recent Calls list. Property Actions: set, get, notify Default Value: Command Definition: Yamaha CS-700 Integrators Reference Guide...

  • Page 32: Require-Https

    Action Definition get require-https response val require-https <0|1> set require-https <0|1> notify notify sys.require-https <0|1> Parameters: Parameter Description Do not require HTTPS Require HTTPS CLI Format Examples: get require-https val require-https 0 set require-https 0 Yamaha CS-700 Integrators Reference Guide...

  • Page 33: 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: Configure power saving time in minutes. Property Actions: set, get, notify Default Value: Command Definition: Action Definition Yamaha CS-700 Integrators Reference Guide...

  • Page 34: Auto-Deploy

    <0|1> set auto-deploy <0|1> notify notify sys.auto-deploy <0|1> Parameters: Parameter Description Disable auto-discovery of provisioning server Enable auto-discovery of provisioning server CLI Format Examples: get auto-deploy val auto-deploy 1 set auto-deploy 1 Yamaha CS-700 Integrators Reference Guide...

  • Page 35: Enable-Deploy

    1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 provisioning-interval Description: Specify the provisioning interval for the device, in minutes. Property Actions: set, get, notify Default Value: 1440 (1 day) Command Definition: Action Definition Yamaha CS-700 Integrators Reference Guide...

  • Page 36: Snmp-Enable

    Definition get snmp-enable response val snmp-enable <0|1> set snmp-enable <0|1> notify notify sys.snmp-enable <0|1> Parameters: Parameter Description Disable SNMP Enable SNMP CLI Format Examples: get snmp-enable val snmp-enable 1 set snmp-enable 1 notify sys.snmp-enable 1 Yamaha CS-700 Integrators Reference Guide...

  • Page 37: Snmp-Community

    Specifies the contact name, typically the system administrator. This string is informational and can include an email address. It is not associated with traps. Property Actions: set, get, notify Command Definition: Action Definition get snmp-contact-name response val snmp-contact-name <"contact"> Yamaha CS-700 Integrators Reference Guide...

  • Page 38: Snmp-Device-Location

    CLI Format Examples: get snmp-device-location val snmp-device-location "Bldg 12 Conf Room CB" set snmp-device-location Bldg 12 Conf Room CB notify sys.snmp-device-location Bldg 12 Conf Room CB Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 dialer-connection-mode Yamaha CS-700 Integrators Reference Guide...
  • Page 39 Disconnect IP dialer No state change IP dialer No state change disconnection and new state is disconnected CLI Format Examples: get dialer-connection-mode val dialer-connection-mode ip set dialer-connection-mode rc notify sys.dialer-connection-mode rc Supported Products: CS700-SP Yamaha CS-700 Integrators Reference Guide...

  • Page 40: Snmp-Address

    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: Command Definition: Action Definition get verbose-log-enabled response val verbose-log-enabled <0|1> set verbose-log-enabled <0|1> notify notify sys.verbose-log-enabled <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 41: Ui-Mask

    For future use, value is ignored Do not allow modifications of call forwarding Do not allow modifications of call history Do not allow modifications of contacts Do not allow modifications of DND CLI Format Examples: get ui-mask val ui-mask 0 Yamaha CS-700 Integrators Reference Guide...

  • Page 42: System Statuses

    USB is not connected. USB is connected. CLI Format Examples: get usb-conn-status val usb-conn-status 1 notify sys.usb-conn-status 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 upgrade-status Description: Query upgrade status. . Property Actions: get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 43: Camera-Upgrade-Status

    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. Yamaha CS-700 Integrators Reference Guide...

  • Page 44: Power-Saving-Status

    Available in API Version: 1.0 usb-aud-rx-status Description: Query state of USB RX audio stream (RX audio being received, stopped). Property Actions: get, notify Command Definition: Action Definition get usb-aud-rx-status response val usb-aud-rx-status <0|1> notify notify sys.usb-aud-rx-status <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 45: Usb-Aud-Tx-Status

    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-status 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 5.2.1.3 System Commands regnotify Description: Register client for notifications. Yamaha CS-700 Integrators Reference Guide...

  • Page 46: Restart

    Definition execute set reset-setting <"category"> Parameters: Parameter Description Reset all properties voip Reset VoIP properties audio Reset audio properties network Reset network properties camera Reset camera properties Reset Bluetooth properties contacts Delete all VoIP contacts Yamaha CS-700 Integrators Reference Guide...

  • Page 47: Audio

    <1|2|3> Parameters: Parameter Description Voice Bass boost Treble boost CLI Format Examples: get eq val eq 1 set eq 1 notify audio.eq 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 high-pass-filter Yamaha CS-700 Integrators Reference Guide...

  • Page 48: Analog-Audio-In-Mode

    Available in API Version: 1.0 analog-audio-in-mode Description: For the TV audio in port, select the gain setting mode, either auto or manual. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get analog-audio-in-mode response val analog-audio-in-mode <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 49: Analog-Audio-In-Gain

    <-12..40> notify notify audio.analog-audio-in-gain <-12..40> Parameters: Parameter Description -12, -11.5..40 Manual gain setting This value can be increased or decreased by 0.5dB CLI Format Examples: get analog-audio-in-gain val analog-audio-in-gain 4.5 set analog-audio-in-gain 4.5 Yamaha CS-700 Integrators Reference Guide...

  • Page 50: 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, notify Default Value: Command Definition: Action Definition get ring-tone response val ring-tone <0..5> set ring-tone <0..5> Yamaha CS-700 Integrators Reference Guide...

  • Page 51: 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 notify audio.ringer-volume 7 Supported Products: CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 52: Audio Statuses

    Available in API Version: 1.1 mute Description: Mute microphones. Property Actions: set, get, notify Command Definition: Action Definition get mute response val mute <0|1> set mute <0|1> notify notify audio.mute <0|1> Parameters: Parameter Description Unmute mics Mute mics Yamaha CS-700 Integrators Reference Guide...

  • Page 53: Mic-Conn-Status

    USB disconnection, it will revert to the default PTZ settings. Calling set on this property will move the camera to the newly set PTZ position. See cam-save-as-defaults to save current PTZ to home setting. Yamaha CS-700 Integrators Reference Guide...

  • Page 54: Camera-Flicker

    Available in API Version: 1.0 camera-flicker Description: Camera's flicker setting. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get camera-flicker response val camera-flicker <1|2> set camera-flicker <1|2> notify notify camera.camera-flicker <1|2> Parameters: Parameter Description 50Hz 60Hz Yamaha CS-700 Integrators Reference Guide...

  • Page 55: Camera-Image-Defaults

    1..255 Gamma setting CLI Format Examples: get camera-image-defaults val camera-image-defaults 1 125 110 100 85 90 220 set camera-image-defaults 1 125 110 100 85 90 220 notify camera.camera-image-defaults 1 125 110 100 85 90 220 Yamaha CS-700 Integrators Reference Guide...

  • Page 56: Camera Statuses

    CLI Format Examples: get camera-status val camera-status on notify camera.camera-status on Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-stream Description: Query state of camera stream (video being sent, stopped) Property Actions: get, notify Command Definition: Yamaha CS-700 Integrators Reference Guide...

  • Page 57: Camera-Door

    Parameter Description open Camera privacy door is open closed Camera privacy door is closed CLI Format Examples: get camera-door val camera-door open notify camera.camera-door open Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-mute Yamaha CS-700 Integrators Reference Guide...

  • Page 58: Camera-Pan

    Camera's digital pan setting. Camera can only be panned when zoomed in. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get camera-pan response val camera-pan <-30..30> set camera-pan <-30..30> notify notify camera.camera-pan <-30..30> Parameters: Parameter Description -30..30 Pan setting Yamaha CS-700 Integrators Reference Guide...

  • Page 59: Camera-Tilt

    Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-zoom Description: Camera's digital zoom setting. When zoom is set to 1, the pan and tilt settings will be forced to zero. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 60: Camera-Backlight

    Backlight compensation for camera. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get camera-backlight response val camera-backlight <0..5> set camera-backlight <0..5> Notify notify camera.camera-backlight <0..5> Parameters: Parameter Description 1..5 Camera Backlight level. Yamaha CS-700 Integrators Reference Guide...

  • Page 61: Camera-Brightness

    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 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 camera-contrast Description: Camera Contrast level Yamaha CS-700 Integrators Reference Guide...

  • Page 62: Camera-Saturation

    Description: Camera Saturation level Property Actions: set, get, notify Default Value: Command Definition: Action Definition get camera-saturation response val camera-saturation <50..150> set camera-saturation <50..150> notify notify camera.camera-saturation <50..150> Parameters: Parameter Description 50..150 Camera Saturation level. Yamaha CS-700 Integrators Reference Guide...

  • Page 63: Camera-Sharpness

    CLI Format Examples: get camera-sharpness val camera-sharpness 100 set camera-sharpness 100 notify camera.camera-sharpness 100 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 camera-hue Description: Camera Hue level Property Actions: set, get, notify Default Value: Yamaha CS-700 Integrators Reference Guide...

  • Page 64: Camera-Gamma

    Default Value: Command Definition: Action Definition get camera-gamma Response val camera-gamma <1..255> set camera-gamma <1..255> Notify notify camera.camera-gamma <1..255> Parameters: Parameter Description 1..255 Camera Gamma level. CLI Format Examples: get camera-gamma val camera-gamma 100 Yamaha CS-700 Integrators Reference Guide...

  • Page 65: Camera Commands

    USB connection has been established, either at startup or after a USB disconnection. Command Definition: Action Definition execute cam-apply-defaults Parameters: None CLI Format Examples: cam-apply-defaults Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 Yamaha CS-700 Integrators Reference Guide...

  • Page 66: Cam-Image-Save-As-Default

    None CLI Format Examples: cam-image-apply-defaults Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 cam-zoom-in Description: Zoom in the camera by one level. Command Definition: Action Definition Execute cam-zoom-in Notify notify camera.zoom <1..22> Parameters: None Yamaha CS-700 Integrators Reference Guide...

  • Page 67: Cam-Zoom-Out

    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 Available in API Version: 1.1 cam-pan-right Description: Pan the camera right by one level. Command Definition: Yamaha CS-700 Integrators Reference Guide...

  • Page 68: Cam-Tilt-Up

    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 Examples: cam-tilt-down notify camera.tilt 5 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 69: Bluetooth

    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: Command Definition: Action Definition get bt-mac response val bt-mac <"mac"> Yamaha CS-700 Integrators Reference Guide...

  • Page 70: Bt-Name

    The Bluetooth basic-rate device name advertised over the air. Property Actions: set, get, notify Default Value: The product 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...

  • Page 71: Bt-Pair-Timeout

    A value of 0 indicates no timeout. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get bt-pair-timeout response val bt-pair-timeout <0..120> set bt-pair-timeout <0..120> notify notify bt.bt-pair-timeout <0..120> Parameters: Parameter Description No timeout 1..120 Pairing timeout in seconds Yamaha CS-700 Integrators Reference Guide...

  • Page 72: Bluetooth Statuses

    Bluetooth is enabled and on Connecting Bluetooth is on and connecting Connected A device is connected CLI Format Examples: get bt-status val bt-status Connected notify bt.bt-status Connected Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-paired-list Yamaha CS-700 Integrators Reference Guide...

  • Page 73: Bt-Connected

    [<"mac"> <"name">] notify notify bt.bt-connected [<"mac"> <"name">] Parameters: Parameter Description MAC address of connected device. name String. Name of connected device. CLI Format Examples: get bt-connected val bt-connected D4:B3:77:EF:31:94 ADR6301 a2dp,hsp notify bt.bt-connected D4:B3:77:EF:31:94 SAMSUNG-G925V Yamaha CS-700 Integrators Reference Guide...

  • Page 74: Bluetooth Commands

    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 Remove all paired devices CLI Format Examples: bt-unpair all Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-disconnect Yamaha CS-700 Integrators Reference Guide...

  • Page 75: Nfc-Enable

    Parameter Description Disable NFC and NFC LED Enable NFC and NFC LED CLI Format Examples: get nfc-enable val nfc-enable 1 set nfc-enable 1 notify bt.nfc-enable 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 76: Call

    Initialization state. incoming Incoming USB call signal is received from host. inactive USB audio is not active. connected Call is connected. onhold USB audio is on hold. connected-in- Call is in a conference. conf BT Calls Yamaha CS-700 Integrators Reference Guide...

  • Page 77: Status-All

    Bluetooth call status statususb USB call status CLI Format Examples: get status-all val status-all line1:disabled line2:disabled line3:disabled bt:idle usb:idle Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0, VoIP Available in API Version: 1.1 call-info Yamaha CS-700 Integrators Reference Guide...

  • Page 78: Number

    Action Definition get number <1..3> response val number <1..3> <"number"> Parameters: Parameter Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) number Caller's phone number CLI Format Examples: get number 1 Yamaha CS-700 Integrators Reference Guide...

  • Page 79: Caller

    Query call start time. Return value is in format HH:MM:SS in 24-hour time. Property Actions: Command Definition: Action Definition get start-time <1..3> response val start-time <1..3> <"time"> Parameters: Parameter Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) Yamaha CS-700 Integrators Reference Guide...

  • Page 80: Codec

    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. Note: The response is a comma separate list of values. Property Actions: Yamaha CS-700 Integrators Reference Guide...

  • Page 81: Call Commands

    1 val call-quality 1 224,227,35840,36320,20,10,12,11,0,20,0,20,200.200.210.131,4000,200.200.210.190,4000 Supported Products: CS700-SP Available in API Version: 1.1 5.2.5.2 Call Commands dial Description: Dial of VoIP call with the given number. Command Definition: Action Definition execute dial <"voip-line-id"> <"number"> Yamaha CS-700 Integrators Reference Guide...

  • Page 82: Answer

    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|bt> Parameters: Parameter Description line-id Line ID of call to be hung up <1..3|usb|bt> Yamaha CS-700 Integrators Reference Guide...

  • Page 83: Hold

    <1..2|usb|bt> Parameters: Parameter Description line-id Line ID of call to be resumed <1..2|usb|bt> CLI Format Examples: resume Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 84: Swap

    Line ID3 of call to be mixed or not mixed [optional] <1..2|usb|bt> line-id4 Line ID4 of call to be mixed or not mixed [optional] <1..2|usb|bt> mix_state Separate lines (not mixed) Join lines (mix) CLI Format Examples: Yamaha CS-700 Integrators Reference Guide...

  • Page 85: Transfer

    3 6175551212 transfer 1 3 Supported Products: CS700-SP Available in API Version: 1.1 play ring-tone Description: Play ring tone by index. Command Definition: Action Definition execute play ring-tone <0..5> Parameters: Parameter Description 0..5 Ring-tone index Yamaha CS-700 Integrators Reference Guide...

  • Page 86: Network

    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 Default Value: Command Definition: Action Definition get dhcp response val dhcp <0|1> set dhcp <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 87: Subnet

    <"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 Products: CS700-AV, CS700-SP Available in API Version: 1.0 subnet Yamaha CS-700 Integrators Reference Guide...

  • Page 88: Gateway

    The Default Gateway is the device's default router on the IP network. Property Actions: set, get, notify Command Definition: Action Definition get gateway response val gateway <"gateway-address"> set gateway <"gateway-address"> notify notify net.gateway <"gateway-address"> Parameters: Parameter Description gateway-address String. IP address. CLI Format Examples: get gateway Yamaha CS-700 Integrators Reference Guide...

  • Page 89: Dns1

    Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 dns2 Description: Address of the secondary Domain Name System (DNS) server. Property Actions: set, get, notify Command Definition: Action Definition get dns2 response val dns2 <"dns-address"> set dns2 <"dns-address"> Yamaha CS-700 Integrators Reference Guide...

  • Page 90: Vlan

    Automatically detect VLAN ID. should be used in environments that provide a Voice VLAN with automatic detection, in which case the device will determine the VLAN identifier and register in that network CLI Format Examples: get vlan val vlan 2 set vlan 2 notify net.vlan 2 Yamaha CS-700 Integrators Reference Guide...

  • Page 91: Vlan-Id

    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, get, notify Default Value: 0.pool.ntp.org Command Definition: Action Definition get ntp1 response val ntp1 <"ntp-address"> Yamaha CS-700 Integrators Reference Guide...

  • Page 92: Ntp2

    Parameters: Parameter Description ntp-address String. IP address or URL or DNS name. CLI Format Examples: get ntp2 val ntp2 1.pool.ntp.org set ntp2 1.pool.ntp.org notify net.ntp2 1.pool.ntp.org Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 Yamaha CS-700 Integrators Reference Guide...

  • Page 93: Ntp3

    Description: Configure fourth NTP (Network Time Protocol) server address. Property Actions: set, get, notify Default Value: none Command Definition: Action Definition get ntp4 response val ntp4 <"ntp-address"> set ntp4 <"ntp-address"> notify notify net.ntp4 <"ntp-address"> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 94: Dot1X-Enabled

    <0|1> Parameters: Parameter Description Disable 802.1x authentication Enable 802.1x authentication CLI Format Examples: get dot1x-enabled val dot1x-enabled 0 set dot1x-enabled 0 notify net.dot1x-enabled 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 Yamaha CS-700 Integrators Reference Guide...

  • Page 95: Dot1X-Identity

    Set a 802.1x authentication password – required for MD5. Property Actions: set, get, notify Command Definition: Action Definition get dot1x-password response val dot1x-password <"password"> set dot1x-password <"password"> notify notify net.dot1x-password <"password"> Parameters: Parameter Description password String. CLI Format Examples: Yamaha CS-700 Integrators Reference Guide...

  • Page 96: Network Commands

    The IP address or DNS name of the SIP registrar server. Required for VoIP call support. Property Actions: set, get, notify Command Definition: Action Definition get registrar response val registrar <"address"> set registrar <"address"> notify notify voip.registrar <"address"> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 97: Registrar-Backup

    <"address"> set registrar-backup <"address"> notify notify voip.registrar-backup <"address"> Parameters: Parameter Description address String. IP address or DNS name. CLI Format Examples: get registrar-backup val registrar-backup 200.200.210.151 set registrar-backup 200.200.210.151 notify voip.registrar-backup 200.200.210.151 Yamaha CS-700 Integrators Reference Guide...

  • Page 98: Realm

    Also note that if the allow strict routing option is set and you have a SIP proxy that is configured for loose routing, add the designation after the proxy's address, for example, '10.134.129.101;lr'. Property Actions: set, get, notify Command Definition: Action Definition get proxy Yamaha CS-700 Integrators Reference Guide...

  • Page 99: Reg-Use-Proxy

    Default Value: Command Definition: Action Definition get reg-use-proxy response val reg-use-proxy <0..3> set reg-use-proxy <0..3> notify notify voip.reg-use-proxy <0..3> Parameters: Parameter Description No proxy Outbound only Acc only CLI Format Examples: get reg-use-proxy val reg-use-proxy 0 Yamaha CS-700 Integrators Reference Guide...

  • Page 100: User

    SIP password for the account used to authenticate with the SIP registrar and proxies. Required for VoIP call support. Property Actions: set, get, notify Command Definition: Action Definition get password response val password <"password"> set password <"password"> Yamaha CS-700 Integrators Reference Guide...

  • Page 101: Name

    <"id"> notify notify voip.id <"id"> Parameters: Parameter Description String. SIP ID. CLI Format Examples: get id val id 7824 set id 7824 notify voip.id 7824 Supported Products: CS700-SP Available in API Version: 1.1 name Yamaha CS-700 Integrators Reference Guide...

  • Page 102: Reg-Timeout

    Registration Timeout is the optional timeout for SIP account registration, in seconds. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get reg-timeout response val reg-timeout <1..604800> set reg-timeout <1..604800> notify notify voip.reg-timeout <1..604800> Parameters: Parameter Description Yamaha CS-700 Integrators Reference Guide...

  • Page 103: Rereg-Delay

    Available in API Version: 1.1 use-timer Description: Specify the preference for using SIP session keep-alive timers. During a SIP session, if SIP session timers are active, the SIP User Agent (UA) periodically sends INVITE or UPDATE Yamaha CS-700 Integrators Reference Guide...

  • Page 104: Timer-Se

    It is measured in seconds. Property Actions: set, get, notify Default Value: 1800 (30 minutes) Command Definition: Yamaha CS-700 Integrators Reference Guide...

  • Page 105: Timer-Min-Se

    Command Definition: Action Definition get timer-min-se response val timer-min-se <1..604800> set timer-min-se <1..604800> notify notify voip.timer-min-se <1..604800> Parameters: Parameter Description 1..604800 Minimum session timer value in seconds CLI Format Examples: get timer-min-se val timer-min-se 90 Yamaha CS-700 Integrators Reference Guide...

  • Page 106: Use-100Rel

    Configure whether SIP traversal behind NAT is disabled. Used for device behind a symmetric NAT (Network Address Translation). When enabled, the device will keep track of the public IP address from the response of the REGISTER request. If it detects that the Yamaha CS-700 Integrators Reference Guide...

  • Page 107: Dtmf-Method

    Available in API Version: 1.1 dtmf-method Description: DTMF signaling method. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get dtmf-method response val dtmf-method <0|1|2> set dtmf-method <0|1|2> notify notify voip.dtmf-method <0|1|2> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 108: Media-Onhold-Method

    0 Supported Products: CS700-SP Available in API Version: 1.1 media-onhold-method Description: The Media on Hold method setting allows switching the Media on Hold behavior between the different RFC definitions. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 109: Use-Srtp

    Description: Controls Secure Real-time Transport Protocol (SRTP) usage. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get use-srtp response val use-srtp <0|1|2> set use-srtp <0|1|2> notify notify voip.use-srtp <0|1|2> Parameters: Parameter Description Yamaha CS-700 Integrators Reference Guide...

  • Page 110: Rtp-Port

    <1024..65535> notify notify voip.rtp-port <1024..65535> Parameters: Parameter Description 1024..65535 Port number CLI Format Examples: get rtp-port val rtp-port 4000 set rtp-port 4000 notify voip.rtp-port 4000 Supported Products: CS700-SP Available in API Version: 1.1 set-qos Yamaha CS-700 Integrators Reference Guide...

  • Page 111: Udp-Tcp-Selection

    Available in API Version: 1.1 udp-tcp-selection Description: Transport that will be used for SIP messages. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get udp-tcp-selection response val udp-tcp-selection <0|1> set udp-tcp-selection <0|1> notify notify voip.udp-tcp-selection <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 112: 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 notify voip.local-port 5060 Supported Products: CS700-SP Available in API Version: 1.1 ip-addr Yamaha CS-700 Integrators Reference Guide...

  • Page 113: Bound-Addr

    – the ip-addr attribute should be used for that purpose. Property Actions: set, get, notify Command Definition: Action Definition get bound-addr response val bound-addr <"ip-address"> set bound-addr <"ip-address"> notify notify voip.bound-addr <"ip-address"> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 114: No-Refer-Sub

    <0|1> Parameters: Parameter Description Disable suppressing subscription Enable suppressing subscription CLI Format Examples: get no-refer-sub val no-refer-sub 0 set no-refer-sub 0 notify voip.no-refer-sub 0 Supported Products: CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 115: Min-Size

    Proxy field, then you must manually add the suffix to each loose-routing proxy address. For example, “10.134.123.101;lr”. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 116: Stun-Srv

    Command Definition: Action Definition get stun-srv response val stun-srv <"stun-address"> set stun-srv <"stun-address"> notify notify voip.stun-srv <"stun-address"> Parameters: Parameter Description stun-address String. IP address, domain name, or host name, and optional port number. Separate Yamaha CS-700 Integrators Reference Guide...

  • Page 117: Use-Ice

    <0|1> notify notify voip.use-ice <0|1> Parameters: Parameter Description Disable ICE Enable ICE CLI Format Examples: get use-ice val use-ice 0 set use-ice 0 notify voip.use-ice 0 Supported Products: CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 118: Ice-Regular

    These interfaces include both physical interfaces and virtual interfaces such as VPN. This option specifies the maximum number of local ICE host candidates that may be used in evaluating candidate pairs when determining the best route. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 119: Ice-No-Rtcp

    Default Value: Command Definition: Action Definition get ice-no-rtcp Response val ice-no-rtcp <0|1> set ice-no-rtcp <0|1> Notify notify voip.ice-no-rtcp <0|1> Parameters: Parameter Description Do not disable RTCP Keep RTCP disabled CLI Format Examples: Yamaha CS-700 Integrators Reference Guide...

  • Page 120: Use-Turn

    <0|1> Notify notify voip.use-turn <0|1> Parameters: Parameter Description Disable TURN Enable TURN CLI Format Examples: get use-turn val use-turn 0 set use-turn 0 notify voip.use-turn 0 Supported Products: CS700-SP Available in API Version: 1.1 turn-srv Yamaha CS-700 Integrators Reference Guide...

  • Page 121: Turn-User

    Username to authenticate against the TURN server. Property Actions: set, get, notify Command Definition: Action Definition get turn-user Response val turn-user <"user-name"> set turn-user <"user-name"> Notify notify voip.turn-user <"user-name"> Parameters: Parameter Description user-name String. CLI Format Examples: get turn-user Yamaha CS-700 Integrators Reference Guide...

  • Page 122: Turn-Passwd

    Available in API Version: 1.1 turn-tcp Description: Configure whether to use TCP on TURN relay; otherwise use UDP. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get turn-tcp Response val turn-tcp <0|1> Yamaha CS-700 Integrators Reference Guide...

  • Page 123: Codec1

    Command Definition: Action Definition get codec1 Response val codec1 <0..5> set codec1 <0..5> Notify notify voip.codec1 <0..5> Parameters: Parameter Description None G.722 G.711 u-law (PCMU) G.711 A-law (PCMA) G.726 G.729 CLI Format Examples: get codec1 Yamaha CS-700 Integrators Reference Guide...

  • Page 124: Codec2

    2 set codec2 2 notify voip.codec2 2 Supported Products: CS700-SP Available in API Version: 1.1 codec3 Description: Third highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1-voip.codec5. Yamaha CS-700 Integrators Reference Guide...

  • Page 125: Codec4

    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: Command Definition: Action Definition get codec4 response val codec4 <0..5> set codec4 <0..5> notify notify voip.codec4 <0..5> Yamaha CS-700 Integrators Reference Guide...

  • Page 126: Codec5

    Default Value: Command Definition: Action Definition get codec5 response val codec5 <0..5> set codec5 <0..5> notify notify voip.codec5 <0..5> Parameters: Parameter Description None G.722 G.711 u-law (PCMU) G.711 A-law (PCMA) G.726 G.729 CLI Format Examples: Yamaha CS-700 Integrators Reference Guide...

  • Page 127: Ptime

    Enable displaying the message waiting indicator (MWI) on the device and enable receiving message waiting notifications from the PBX. The PBX must be configured to support voice mail for the registered user in order for this feature to work properly. Property Actions: set, get, notify Yamaha CS-700 Integrators Reference Guide...

  • Page 128: Vm-Number

    Command Definition: Action Definition get vm-number response val vm-number <"vm-number"> set vm-number <"vm-number"> notify notify voip.vm-number <"vm-number"> Parameters: Parameter Description vm-number String. VoIP voicemail number. CLI Format Examples: get vm-number val vm-number 7243 Yamaha CS-700 Integrators Reference Guide...

  • Page 129: Vm-Count

    Available in API Version: 1.1 do-not-disturb Description: Configure do-not-disturb (DND) setting. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get do-not-disturb response val do-not-disturb <0|1> set do-not-disturb <0|1> notify notify voip.do-not-disturb <0|1> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 130: Auto-Answer

    <0|100..699> notify notify voip.auto-answer <0|100..699> Parameters: Parameter Description Disable auto-answer 100..699 RESPONSE to send when answering CLI Format Examples: get auto-answer val auto-answer 0 set auto-answer 0 notify voip.auto-answer 0 Supported Products: CS700-SP Yamaha CS-700 Integrators Reference Guide...

  • Page 131: Duration

    Specifies the VoIP dial plan string. See the User's Guide for a detailed description of dial plan settings. Property Actions: set, get, notify Command Definition: Action Definition get dial-plan response val dial-plan <"dial-plan"> set dial-plan <"dial-plan"> notify notify voip.dial-plan <"dial-plan"> Yamaha CS-700 Integrators Reference Guide...

  • Page 132: Always-Forwarding

    <0|1> set always-forwarding <0|1> notify notify voip.always-forwarding <0|1> Parameters: Parameter Description Disable Enable CLI Format Examples: get always-forwarding val always-forwarding 0 set always-forwarding 0 notify voip.always-forwarding 0 Supported Products: CS700-SP Available in API Version: 1.1 Yamaha CS-700 Integrators Reference Guide...

  • Page 133: Always-Forwarding-Num

    'Do Not Disturb' mode or if both lines are busy. Property Actions: set, get, notify Default Value: Command Definition: Action Definition get busy-forwarding response val busy-forwarding <0|1> set busy-forwarding <0|1> notify notify voip.busy-forwarding <0|1> Parameters: Yamaha CS-700 Integrators Reference Guide...

  • Page 134: Busy-Forwarding-Num

    Supported Products: CS700-SP Available in API Version: 1.1 noanswer-forwarding Description: Enable or disable forwarding incoming VoIP calls to the specified number if the call is not answered within the duration specified in the 'noanswer-delay' attribute. Yamaha CS-700 Integrators Reference Guide...

  • Page 135: Noanswer-Forwarding-Num

    'noanswer-delay' attribute. Property Actions: set, get, notify Command Definition: Action Definition get noanswer-forwarding-num response val noanswer-forwarding-num <"fwd-number"> set noanswer-forwarding-num <"fwd-number"> notify notify voip.noanswer-forwarding-num <"fwd-number"> Parameters: Parameter Description fwd-number String. VoIP dialing number. Yamaha CS-700 Integrators Reference Guide...

  • Page 136: Noanswer-Delay

    Seconds to wait before forwarding a call CLI Format Examples: get noanswer-delay val noanswer-delay 10 set noanswer-delay 10 notify voip.noanswer-delay 10 Supported Products: CS700-SP Available in API Version: 1.1 5.2.7.2 VoIP Statuses registration Description: Query SIP registration status. Yamaha CS-700 Integrators Reference Guide...

  • Page 137: Voip Commands

    Parameter Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) digit dtmf digit, use - to stop previous DTMF digit CLI Format Examples: set dtmf 1 5 set dtmf 1 - Yamaha CS-700 Integrators Reference Guide...

  • Page 138: Set Voip-Commit

    Once the CS-700 receives address information for a provisioning server, it tries to access configuration files on that server to auto-configure the device. The configuration file for a specific device needs to be named as follows: Yamaha CS-700 Integrators Reference Guide...

  • Page 139: 6.1 Provisioning Files

    Filename: F0DEF1A064E6.xml for the unit with the MAC address f0:DE:F1:A0:64:E6 <provisioning include="enterprise.xml, department.xml"> <config voip.id="test" voip.name="test" voip.user="test" voip.password="test" /> </provisioning> Sample enterprise configuration file Filename: enterprise.xml <provisioning> <firmware version="2.6.0.294">CS-700-2-6-0-294.bundle</firmware> <config voip.registrar="200.200.210.240" voip.registrar-backup="" voip.realm="*" voip.reg-use-proxy="0" voip.proxy="" /> </provisioning> Sample department configuration file Yamaha CS-700 Integrators Reference Guide...

  • Page 140: 6.2 Provisioning File Parameters

    0 : Disable button Enable/disable the bluetooth 1 : Enable button Bluetooth button on the main unit. sys.enable-led- BOOLEAN 0 : Disable LED Enable/disable the call call 1 : Enable LED state LED on the main unit. Yamaha CS-700 Integrators Reference Guide...
  • Page 141 (Sunday = 1, Saturday = 7) and hour that the time changes. A week value of 5 indicates the last week of the month. The default is the US DST rule of the first Sunday in November at 2 Yamaha CS-700 Integrators Reference Guide...
  • Page 142 0 : Power save mode Configure power saving mode is off mode setting. 1 : Power save mode is on sys.power-saving- NUMBER timeout : Power save Configure power saving time timeout in minutes time in minutes. Yamaha CS-700 Integrators Reference Guide...
  • Page 143 4 : Do not allow modifications of call forwarding 8 : Do not allow modifications of call history 16 : Do not allow modifications of contacts 32 : Do not allow modifications of DND Yamaha CS-700 Integrators Reference Guide...
  • Page 144 <-18..18> has been established, zoom: <1..22> either at startup or after a USB disconnection, it will revert to the default PTZ settings. camera.camera- NUMBER 1 : 50Hz Camera's flicker setting. flicker 2 : 60Hz Yamaha CS-700 Integrators Reference Guide...
  • Page 145 Subnet Mask to determine the subnet to which the device belongs. net.gateway TEXT IP address. The Default Gateway is the device's default router on the IP network. net.dns1 TEXT IP address. Address of the primary Domain Name System Yamaha CS-700 Integrators Reference Guide...
  • Page 146 Enables 802.1x enabled authentication authentication to access 1 : Enable 802.1x the network. When authentication enabled, the 802.1x authentication type and the required credentials also need to be specified. MD5 authentication requires a username and password. Yamaha CS-700 Integrators Reference Guide...
  • Page 147 2 : Acc only "proxy" property should be 3 : All used when registering. Selecting this option will add the listed proxy server(s) to the route headers of the SIP REGISTER request. Yamaha CS-700 Integrators Reference Guide...
  • Page 148 INDEXED_ 0 : Inactive Specify the preference for OPTION 1 : Optional using SIP session keep-alive 2 : Mandatory timers. 3 : Always Yamaha CS-700 Integrators Reference Guide...
  • Page 149 ACK; however, in some cases, such as for PSTN interoperability support, reliability of provisional types of responses is needed. Choose this option to add the PRACK (provisional ACK) message support for reliability. Yamaha CS-700 Integrators Reference Guide...
  • Page 150 BOOLEAN 0 : M line only -- The Media on Hold method onhold-method RFC3264 setting allows switching the 1 : M and C line -- Media on Hold behavior RFC2543 between the different RFC definitions. Yamaha CS-700 Integrators Reference Guide...
  • Page 151 For example, it can point to the public address of a NAT router where port mappings have been configured for SIP.. voip.bound-addr TEXT ip-address : IP Configure bound IP address address we intend to use. Yamaha CS-700 Integrators Reference Guide...
  • Page 152 SIP headers in their short forms to reduce size. By default, the option is not enabled and SIP headers in outgoing messages will be encoded in their full names. (See SIP protocol standard, IETF RFC 3261.) Yamaha CS-700 Integrators Reference Guide...
  • Page 153 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.) Yamaha CS-700 Integrators Reference Guide...
  • Page 154 VPN. This option specifies the maximum number of local ICE host candidates that may be used in evaluating candidate pairs when determining the best route. Yamaha CS-700 Integrators Reference Guide...
  • Page 155 Second highest prioritized OPTION 1 : G.722 codec. At least one codec 2 : G.711 u-law different from “None” has (PCMU) to be selected in 3 : G.711 A-law voip.codec1-voip.codec5. (PCMA) 4 : G.726 5 : G.729 Yamaha CS-700 Integrators Reference Guide...
  • Page 156 TEXT VoIP voicemail The number that is dialed number. when voicemail is called from the UI. voip.do-not- BOOLEAN 0 : Disable DND Configure do-not-disturb disturb 1 : Enable DND (DND) setting. Yamaha CS-700 Integrators Reference Guide...
  • Page 157 BOOLEAN 0 : Disable Enable or disable forwarding 1 : Enable forwarding incoming VoIP calls to the specified number if the call is not answered within the duration specified in the 'noanswer-delay' attribute. Yamaha CS-700 Integrators Reference Guide...

  • Page 158: Snmp

    • USB connection active (0,1) • USB microphone audio stream active (0,1) • USB speaker audio stream active (0,1) • USB video stream active (0,1) Bluetooth connection active (0,1) • VoIP call active (0,1) • Yamaha CS-700 Integrators Reference Guide...
  • Page 159 "postal: Yamaha Unified Communications 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 }...
  • Page 160 SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Current VoIP call lines 1-3 call state of type String." ::= {cs700 18} -- CS-700 traps usbConnTrap OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "USB connection trap data" Yamaha CS-700 Integrators Reference Guide...
  • Page 161 ::= { cs700TrapsObjects 1 } usbConnTrapHit NOTIFICATION-TYPE OBJECTS { usbconnTrap } STATUS current DESCRIPTION "Generated when USB connection state changes" ::= { cs700Traps 1 } Yamaha CS-700 Integrators Reference Guide...

  • Page 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. Yamaha CS-700 Integrators Reference Guide...

  • Page 163: Appendix B - Crestron Integration Tcp/Ip

    1 1 2 1 Since USB and Bluetooth are both optional in the join, join 1 1 2 1 is identical to join 1 1 2 1 usb 0 bt 0. Hold calls in conference Yamaha CS-700 Integrators Reference Guide...
  • Page 164 Note, leaving two lines in active state without holding either or both will produce undefined telephony behavior. hold 2 At this point, line 1 remains active, and line 2 goes on hold. Answer SIP calls with active USB line, then conferencing all of them together Yamaha CS-700 Integrators Reference Guide...
  • Page 165 At this point, calls (USB, line 2) are in an active conference, and line 1 in on hold, outside the conference. Hold all calls The user starts with all lines in conference. hold all At this point, all lines are on hold, and not in conference. Resume calls and conference them Yamaha CS-700 Integrators Reference Guide...
  • Page 166 1 At this point, line1 is disconnected and removed from conference, but USB is still in conference. join 1 0 2 0 usb 0 At this point, USB is active and outside the conference. Yamaha CS-700 Integrators Reference Guide...

This manual is also suitable for:

Cs700-spCs700-av

Table of Contents