poly Studio R30 Parameter Reference Instructions

poly Studio R30 Parameter Reference

Product Information

Parameter Reference Guide

The Parameter Reference Guide provides a list of available configuration parameters for provisioning your Poly Studio R30 USB video bar.

Before You Begin

This guide is written for a technical audience, especially for administrators operating Poly Lens and FTPS/HTTPS provisioning.

Related Poly and Partner Resources

For information on privacy policy and data processing, please refer to the Poly Privacy Policy. You can direct any comments or questions to privacy@poly.com.

Getting Started

You can configure, manage, and monitor your Poly Studio R30 system using parameters in Poly Lens or your own FTPS/HTTPS server.

Understanding Parameter Lists

The following information describes the general convention for parameter list details. Parameter details vary depending on the complexity of the parameter.

Parameter Name| Description| Permitted Values| Default Value| Unit of Measure| Note
---|---|---|---|---|---
device.local.country| Specifies the country where the system is located.| Not set (default), Global, Afghanistan, Albania, Algeria,
American Samoa, Andorra, Angola, Anguilla, Antarctica, Antigua,
Argentina, Armenia, Aruba, Ascension Islands, Australia, Australian
Ext. Territories, Austria, Azerbaijan, Bahamas, Bahrain,
Bangladesh, Barbados, Barbuda, Belarus, Belgium, Belize, Benin
Republic, Bermuda, Bhutan, Bolivia, Bosnia and Herzegovina,
Botswana, Brazil, British Virgin Islands, British Indian Ocean
Territory, Brunei, Bulgaria, Burkina Faso, Burma (Myanmar),
Burundi, Cambodia, Cameroon, United Republic Canada, Cape Verde
Island, Cayman Islands, Central African Republic, Chad Republic,
Chile, China, Christmas Island, Cocos Islands, Colombia, Comoros,
Congo, Congo Democratic Republic, Cook Islands, Costa Rica,
Croatia, Cuba, Curacao, Cyprus, Czech Republic, Denmark, Diego
Garcia, Djibouti, Dominica, Dominican Republic, Easter Island, East
Timor| Not set (default)| –| –

General Settings

This section describes available configuration parameters for general settings such as system name and Bluetooth. It includes permitted values and guidance for configuring related parameters.

To enable FTPS or HTTPS provisioning:

1. The correct file names are .cfg and -provisioning.cfg.
2. In .cfg, edit the CONFIG_FILES line as CONFIG_FILES=-provisioning.cfg and save.
3. Edit the parameters in -provisioning.cfg as needed and save.
4. Put both files in the root folder of the FTPS or HTTPS server.

Note: Make sure you follow the spelling of the value options. All values are case-sensitive.

Before You Begin

This guide lists the available configuration parameters for provisioning your Poly Studio R30 USB video bar.

Audience, Purpose, and Required Skills
This guide is written for a technical audience, especially for the administrators operating Poly Lens and FTPS/HTTPS provisioning.

Related Poly and Partner Resources
See the following sites for information related to this product.

• Poly Support is the entry point to online product, service, and solution support information. Find product-specific information such as Knowledge Base articles, Support Videos, Guide & Manuals, and Software Releases on the Products page, download software for desktop and mobile platforms from Downloads & Apps, and access additional services.
• The Poly Documentation Library provides support documentation for active products, services, and solutions. The documentation displays in responsive HTML5 format so that you can easily access and view installation, configuration, or administration content from any online device.
• The Poly Community provides access to the latest developer and support information. Create an account to access Poly support personnel and participate in developer and support forums. You can find the latest information on hardware, software, and partner solutions topics, share ideas, and solve problems with your colleagues.
• The Poly Partner Network is a program where resellers, distributors, solutions providers, and unified communications providers deliver high-value business solutions that meet critical customer needs, making it easy for you to communicate face-to-face using the applications and devices you use every day.
• Poly Services help your business succeed and get the most out of your investment through the benefits of collaboration. Enhance collaboration for your employees by accessing Poly service solutions, including Support Services, Managed Services, Professional Services, and Training Services.
• With Poly+ you get exclusive premium features, insights and management tools necessary to keep employee devices up, running, and ready for action.
• Poly Lens enables better collaboration for every user in every workspace. It is designed to spotlight the health and efficiency of your spaces and devices by providing actionable insights and simplifying device management.

Privacy Policy
Poly products and services process customer data in a manner consistent with the Poly Privacy Policy. Please direct comments or questions to privacy@poly.com.

Getting Started

You can configure, manage, and monitor your Poly Studio R30 system using parameters in Poly Lens or your own FTPS/HTTPS server.

Understanding Parameter Lists
The following information describes the general convention for parameter list details. Parameter details vary depending on the complexity of the parameter.

parameter.name

• A parameter’s description, applicability, or dependencies.
• The parameter’s permitted values, default value, and the value’s unit of measure (such as seconds, Hz, or dB).
• A note that highlights critical information you need to know.

Note: Some parameters use check boxes as value options on the provisioning server’s web interface, where selected check boxes indicate true and cleared check boxes indicate false.

Enable FTPS or HTTPS Provisioning
Poly Studio R30 supports FTPS or HTTPS provisioning.
Poly recommends that you use Poly provisioning services for better performance, but you can use simple FTPS or HTTPS provisioning as well.

Note: Poly Studio R30 only supports FTPS servers that don’t reuse the TLS/SSL session for data connection. Make sure that your server settings are correct if the connection to your FTPS server fails.

Task

1. Download both provisioning templates from the Poly Support.

2. Rename the files to replace SN with your serial number.
   The correct file names are .cfg and

   -provisioning.cfg.

3. In .cfg, edit the CONFIG_FILES line as CONFIG_FILES=”- provisioning.cfg” and save.

4. Edit the parameters in -provisioning.cfg as you need and save.
   The order of the parameters in the provisioning file matches the order that the parameters get deployed in. When conflicted, the earlier-provisioned parameter takes priority except for specified cases.
   Important: Make sure you follow the spelling of the value options. All the values are case-sensitive.

5. Put both files in the root folder of the FTPS or HTTPS server.

General Settings

This section describes available configuration parameters for general settings (for example, system name and bluetooth). Included are permitted values and, if applicable, guidance for configuring related parameters.

device.local.country

Specifies the country where the system is located.

• Not set (default)

• Global

• Afghanistan

• Albania

• Algeria

• American Samoa

• Andorra

• Angola

• Anguilla

• Antarctica

• Antigua

• Argentina

• Armenia

• Aruba

• Ascension Islands

• Australia

• Australian Ext. Territories

• Austria

• Azerbaijan

• Bahamas

• Bahrain

• Bangladesh

• Barbados

• Barbuda

• Belarus

• Belgium

• Belize

• Benin Republic

• Bermuda

• Bhutan

• Bolivia

• Bosnia and Herzegovina

• Botswana

• Brazil

• British Virgin Islands

• British Indian Ocean Territory Brunei

• Bulgaria

• Burkina Faso

• Burma (Myanmar)

• Burundi

• Cambodia

• Cameroon United Republic Canada

• Cape Verde Island

• Cayman Islands

• Central African Republic Chad Republic

• Chile

• China

• Christmas Island

• Cocos Islands

• Colombia

• Comoros

• Congo

• Congo Democratic Republic Cook Islands

• Costa Rica

• Croatia

• Cuba

• Curacao

• Cyprus

• Czech Republic

• Denmark

• Diego Garcia

• Djibouti

• Dominica

• Dominican Republic

• Easter Island

• East Timor

• Ecuador

• Egypt

• El Salvador

• Equatorial Guinea

• Eritrea

• Estonia

• Ethiopia

• Faeroe Islands

• Falkland Islands

• Fiji Islands

• Finland

• France

• French Antilles

• French Guiana

• French Polynesia

• French Southern and Antarctic Lands Gabon

• Gambia

• Georgia

• Germany

• Ghana

• Gibraltar

• Greece

• Greenland

• Grenada

• Guadeloupe

• Guam

• Guantanamo Bay

• Guatemala

• Guinea

• Guernsey

• Guinea-Bissau

• Guyana

• Haiti

• Honduras

• Hong Kong

• Hungary

• Iceland

• India

• Indonesia

• Inmarsat (Atlantic Ocean West) Inmarsat (Atlantic Ocean East) Inmarsat (Indian Ocean) Inmarsat (Pacific Ocean) Inmarsat (SNAC)

• Iran

• Iraq

• Ireland

• Israel

• Italy

• Ivory Coast

• Jamaica

• Japan

• Jersey

• Jordan

• Kazakhstan

• Kenya

• Kiribati

• Korea North

• Korea South

• Kosovo

• Kuwait

• Kyrgyzstan

• Laos

• Latvia

• Lebanon

• Lesotho

• Liberia

• Libya

• Liechtenstein

• Lithuania

• Luxembourg

• Macao

• Macedonia

• Madagascar

• Malawi

• Malaysia

• Maldives

• Mali

• Malta

• Man, Isle of Mariana Islands Marshall Islands Martinique Mauritania Mauritius

• Mayotte Island Mexico Micronesia Midway Island Moldova

• Monaco

• Mongolia Montenegro Montserrat Morocco Mozambique Myanmar (Burma) Namibia

• Nauru

• Nepal

• Netherlands Netherlands Antilles Nevis

• New Caledonia New Zealand Nicaragua

• Niger

• Nigeria

• Niue

• Norfolk Island Norway

• Oman

• Pakistan

• Palau

• Palestine

• Panama

• Papua New Guinea Paraguay

• Peru

• Philippines

• Pitcairn

• Poland

• Portugal

• Puerto Rico

• Qatar

• Reunion Island Romania

• Russia

• Rwanda

• St Helena

• St Kitts

• St Lucia

• St Pierre and Miquelon St Vincent

• San Marino

• Sao Tome and Principe Saudi Arabia

• Senegal

• Serbia

• Seychelles

• Sierra Leone Singapore

• Slovakia

• Slovenia

• Solomon Islands Somalia Republic South Africa

• Spain

• Sri Lanka

• Sudan

• Suriname

• Swaziland

• Sweden

• Switzerland

• Syria

• Taiwan

• Tajikistan

• Tanzania

• Thailand

• Togo

• Tonga

• Trinidad and Tobago Tunisia

• Turkey

• Turkmenistan

• Turks and Caicos

• Tuvalu

• Uganda

• Ukraine

• United Arab Emirates United Kingdom

• United States

• Uruguay

• US Minor Outlying Islands US Virgin Islands Uzbekistan

• Vanuatu

• Vatican City

• Venezuela

• Vietnam

• Wake Island
  Wallis And Futuna Islands Western Samoa

• Yemen

• Zambia

• Zanzibar

Zimbabwe

• device.local.deviceName
  Specifies the device name. Bluetooth uses the same identifier. String (0 to

40. Poly Studio R30 (default)

• bluetooth.enable
  Specifies whether to enable Bluetooth functions. true (default)
  false

• bluetooth.ble.enable
  Specifies whether to enable the Bluetooth remote control. true (default)
  false

• bluetooth.autoConnection
  Specifies whether to automatically connect to the paired Bluetooth devices. true (default)
  false

• device.local.ntpServer.address.1
  Specifies the time server IP address. It applies when the mode is set to Manual. String (0 to 255)

• device.local.ntpServer.mode
  Specifies the time server mode. auto (default)
  manual

• device.syslog.enable
  Specifies whether to send log information to the log server. true
  false (default)

• device.syslog.serverName
  Specifies the URL where to upload the log information. String (0 to 255)

• device.syslog.interval
  Specifies (in seconds) how often the system sends logs to the log server. Integer (1 to 4000000) 18000 (default)
  If this parameter isn’t set, the device doesn’t upload the system logs.

Network Settings

This section describes available configuration parameters for network settings. Included are permitted values and, if applicable, guidance for configuring related parameters.
Note: device.wifi.paramOn must be included and set to true to allow setting any other device.wifi.* parameters

• device.wifi.paramOn
  Enables all Wi-Fi network parameters. true
  false (default)

• device.wifi.autoConnect
  Specifies whether to connect to the saved Wi-Fi network automatically when it’s available.
  true (default)
  false

• device.wifi.dhcp.enable
  Specifies whether to use DHCP server to obtain the IP settings automatically for your system Wi-Fi network.
  If you set “true”, make sure you have a DHCP server in your environment.
  true
  false (default)

• device.wifi.dns.server.1
  If the system doesn’t automatically obtain a DNS server address, enter one here.
  If device.wifi.dhcp.enable=”true”, this doesn’t apply.
  String (0 to 40)

• device.wifi.dns.server.2
  If the system doesn’t automatically obtain a DNS server address, enter one here.
  If device.wifi.dhcp.enable=”true”, this doesn’t apply.
  String (0 to 40)

• device.wifi.dot1x.anonymousIdentity
  Specify an anonymous identity used for 802.1x authentication.
  String (0 to 40)

• device.wifi.dot1x.identity
  Specifies the system’s identity used for 802.1x authentication.
  String (0 to 40)

• device.wifi.dot1x.password
  Specifies the system’s password used for authentication.
  String (0 to 40)

• device.wifi.dot1xEAP.EAP.method
  Specifies the extensible authentication protocol (EAP) for WPA-Enterprise (802.1xEAP).
  Set this if device.wifi.securityType=”802_1xEAP”.
  PEAP (default)
  TLS
  TTLS
  PWD

• device.wifi.dot1xEAP.phase2Auth
  Specifies the Phase 2 authentication method.
  Set this if device.wifi.securityType=”802_1xEAP”.
  NONE (default)
  MSCHAPV2
  GTC

• device.wifi.ipAddress
  Specifies the system IPv4 address.
  If device.wifi.dhcp.enable=”true”, this doesn’t apply.
  String (0 to 40)

• device.wifi.ipGateway
  Specifies the IP gateway for the Wi-Fi network.
  If device.wifi.dhcp.enable=”true”, this doesn’t apply.
  String (0 to 40)

• device.wifi.securityType
  Specifies the Wi-Fi network encryption protocol.
  Not set (default)
  None
  WEP
  PSK
  EAP

• device.wifi.ssid
  Specifies the name of the Wi-Fi network you’re connecting systems to.
  String (0 to 40)

• device.wifi.subnetMask
  Specifies the subnet mask address for the Wi-Fi network.
  If device.wifi.dhcp.enable=”true”, this doesn’t apply.
  String (0 to 40)

• device.wifi.TLS.CAcert
  Specifies whether to authenticate the certificate authority (CA) of the Wi-Fi network.
  true
  false (default)

• device.wifi.TLS.clientCert
  Specifies whether to authenticate users who are connecting to this Wi-Fi network.
  true
  false (default)

Security Settings

This section describes available configuration parameters for security settings. Included are permitted values and, if applicable, guidance for configuring related parameters.

• sec.auth.admin.password
  Specifies the password required to access the Admin Settings page in Poly Lens Desktop.
  String (0 to 32)
  Poly12#$ (default)
  Note: If you provision a blank password to your device, you can only change the password via provisioning. You can’t change the password from the Poly Lens Desktop application unless you reset the device.

• sec.auth.admin.password.enable
  Specifies whether to require a password to access the Admin Settings page in Poly Lens Desktop.
  true
  false (default)

• sec.auth.simplePassword
  Specifies whether to allow a simple password for login.
  true
  false (default)

• sec.server.cert.CAvalidate
  Determines whether your system requires a remote server to present a valid certificate when connecting to it for services, such as provisioning.
  true
  false (default)

Audio Settings

This section describes available configuration parameters for audio settings. Included are permitted values and, if applicable, guidance for configuring related parameters.

• voice.acousticBeam.enable
  Specifies whether to enable Polycom Acoustic Fence with Beam Shaping and how big is the coverage.
  Off (default)
  Wide
  Narrow
  Medium
  Camera-View

• voice.eq.bass
  Adjusts audio equalizer bass level of the speaker.
  Integer (-6 to 6)
  0 (default)

• voice.eq.treble
  Adjusts audio equalizer treble output from the speaker.
  Integer (-6 to 6)
  0 (default)

• voice.noiseBlock.enable
  Specifies whether to enable NoiseBlockAI to prevent the noise from transmitting to the far end during video conferences.
  true (default)
  false

• voice.noiseBlockAI.enable
  Specifies whether to prevent noise from the far end during video conferences.
  true
  false (default)

Video Settings

This section describes available configuration parameters for video settings including camera settings. Included are permitted values and, if applicable, guidance for configuring related parameters.
Note: Selecting any one of conversation_view, gallery_view, and lecture_mode, will disable the other two modes.

• conversation_view
  Specifies whether to enable the Conversation Mode feature. When enabled, those settings override: video.camera.trackingMode=”FrameSpeaker”, zoom_Level=”4″, and lecture_mode=”false”.
  true
  false (default)

• gallery_view
  Specifies whether to enable the People Framing feature.
  This setting only applies when video.camera.trackingMode=”FrameGroup”, zoom_Level=”4″, conversation_view=”false”, and lecture_mode=”false”.
  true
  false (default)

• lecture_mode
  Specifies whether to enable the Presenter Mode feature.
  This setting only activate when the video.camera.trackingMode=”FrameSpeaker” and conversation_view=”false”.
  true
  false (default)

• smooth_transition
  Specifies whether to let the camera pan smoothly between speakers or groups.
  true
  false (default)

• video.camera.antiFlicker
  Adjusts the power frequency to reduce flicker in the video.
  50
  60 (default)

• video.camera.backlightComp
  Specifies whether to enable backlight compensation.
  true
  false (default)

• video.camera.groupViewSize
  Specifies the framing size of the camera.
  Wide
  Medium (default)
  Tight

• video.camera.imageMirrorFlip
  Specifies whether to mirror or flip the video image. For inverted mounting, set the value to MirrorAndFlip.
  MirrorAndFlip
  Disabled (default)

• video.camera.osdEnable
  Specifies whether to enable the onscreen display (OSD) overlay for video debugging.
  true
  false (default)

• video.camera.trackingMode
  Specifies the tracking mode of the camera.
  Off (default)
  FrameGroup
  FrameSpeaker

• video.camera.trackingSpeed
  Specifies the tracking speed of the camera.
  Fast
  Normal (default)
  Slow

• zoom_level
  Specifies the maximum zoom ratio when video.camera.trackingMode is not Off.
  2
  3
  4 (default)
  The numbers stand for 2×, 3×, or 4× zoom-in level.

Provisioning and Upgrading Settings

Use the following configuration parameters to provision and upgrade your system. Included are permitted values and, if applicable, guidance for configuring related parameters.

• lens.connection.enable
  Enables Poly Lens to perform management tasks including configuration synchronization, people count reporting, and remote system reboot. Disable it if you don’t want the device to connect with the Poly Lens cloud service.
  true (default)
  false

• prov.heartbeat.interval
  Specifies (in seconds) how often the USB video bar sends the heartbeat message to the provisioning server. The default is 10 minutes.
  Integer (1 to 65535)
  600 (default)

• prov.password
  Specifies the provisioning server’s login password. This setting only applies when prov.server.mode=“manual”.
  String (0 to 255)

• prov.polling.period
  Specifies, in seconds, how often the USB video bar requests the provisioning file. The default is 24 hours.
  Integer (≥60)
  86400 (default)

• prov.server.mode
  Specifies the method of provisioning.
  Manual
  Auto: Gets the provisioning server URL from your DHCP option 66 or 150.
  Disable (default)

• prov.server.type
  Specifies the type of provisioning server. This setting only applies when prov.server.mode=“manual”.
  HTTPS: Uses your own HTTPS server (non-Poly Provisioning Service)
  FTPS: Uses your own FTPS server (non-Poly Provisioning Service)
  CLOUD (default): Uses a Poly Provisioning Service (Poly Lens).

• prov.url
  Specifies the URL of the provisioning server. This setting only applies when prov.server.mode=“manual”.
  String (0 to 255)

• prov.username
  Specifies the provisioning server’s login username. This setting only applies when prov.server.mode=“manual”.
  String (0 to 255)

• upgrade.auto.enable
  Specifies whether to upgrade the firmware via the provisioning server. If set to false, use Poly Lens Desktop to upgrade.
  true
  false (default)

Support

NEED MORE HELP?
poly.com/support

Poly Worldwide Headquarters
345 Encinal Street Santa Cruz, CA 95060 United States
© 2022 Poly. Bluetooth is a registered trademark of Bluetooth SIG, Inc. All trademarks are the property of their respective owners.

References

• Home - HP Support Community
• Poly Documentation Library
• poly.com/support
• Poly | Video & Voice Collaboration Solutions | HP® Official Site
• Poly Conferencing Solutions by Industry | HP® Official Site
• Poly | Headset & Video Software & Services | HP® Official Site
• Poly Lens Device Management | HP® Official Site
• Poly | Headset & Video Software & Services | HP® Official Site
• poly.com/us/en/support

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>