Difference between revisions of "ROAM Manual"

From IVS Wiki
Jump to: navigation, search
(→‎VALT)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
=Information=
+
{{Article - Manual | content =  
−
=Settings=
+
<h1>Information</h1>
−
[[File:ROAM_Manual_2.png]]
+
<h1>Settings</h1>
 +
{{img - resize | file = ROAM_Manual_2.png}}
 
:To access the settings page first click the gear icon in the bottom right.
 
:To access the settings page first click the gear icon in the bottom right.
−
[[File:ROAM_Manual_3.png]]
+
{{img - resize | file = ROAM_Manual_3.png}}
 
:You will be prompted to enter the password before you can access the settings menu. The default password is admin51.
 
:You will be prompted to enter the password before you can access the settings menu. The default password is admin51.
−
[[File:ROAM_Manual_4.png]]
+
{{img - resize | file = ROAM_Manual_4.png]]}}
 
:Each of the settings sections can be accessed from the drop menu at the top of the screen.
 
:Each of the settings sections can be accessed from the drop menu at the top of the screen.
 
===Application===
 
===Application===
−
[[File:ROAM_Manual_4.png]]
+
{{img - resize | file = ROAM_Manual_4.png}}
 
:Settings on this page relate to the overall application.
 
:Settings on this page relate to the overall application.
 
====Application Settings====
 
====Application Settings====
Line 29: Line 30:
  
 
===Camera Control===
 
===Camera Control===
−
[[File:ROAM_Manual_5.png]]
+
{{img - resize | file = ROAM_Manual_5.png}}
 
:Settings on this page are specific to the camera control application. These are utilized by the ROAM cart.
 
:Settings on this page are specific to the camera control application. These are utilized by the ROAM cart.
 
=====Stream Type=====
 
=====Stream Type=====
Line 41: Line 42:
  
 
===Keypad===
 
===Keypad===
−
[[File:ROAM_Manual_6.png]]
+
{{img - resize | file = ROAM_Manual_6.png}}
 
:Settings on this page are specific to the keypad application.
 
:Settings on this page are specific to the keypad application.
 
=====Pin Length=====
 
=====Pin Length=====
Line 47: Line 48:
  
 
===Smart Button===
 
===Smart Button===
−
[[File:ROAM_Manual_7.png]]
+
{{img - resize | file = ROAM_Manual_7.png}}
 
:Settings on this page are specific to the Smart Button application. The smart button is design to be run in portrait mode.
 
:Settings on this page are specific to the Smart Button application. The smart button is design to be run in portrait mode.
 
=====Recording Button=====
 
=====Recording Button=====
Line 58: Line 59:
 
Toggles the Comment Controls On or Off. This feature will only function with a VALT server.
 
Toggles the Comment Controls On or Off. This feature will only function with a VALT server.
 
===System===
 
===System===
−
[[File:ROAM_Manual_10.png]]
+
{{img - resize | file = ROAM_Manual_10.png}}
 
:Settings on this page are system wide settings.
 
:Settings on this page are system wide settings.
 
=====Debug Mode=====
 
=====Debug Mode=====
Line 70: Line 71:
  
 
===ROAM===
 
===ROAM===
−
[[File:ROAM_Manual_8.png]]
+
{{img - resize | file = ROAM_Manual_8.png}}
 
:Settings on this page are specific to the ROAM cart. The ROAM cart is comprised of several devices with an internal network facilitating communication between these devices.
 
:Settings on this page are specific to the ROAM cart. The ROAM cart is comprised of several devices with an internal network facilitating communication between these devices.
 
====ROAM Bridge Config====
 
====ROAM Bridge Config====
Line 82: Line 83:
 
=====ROAM PAssword=====
 
=====ROAM PAssword=====
 
This setting specifies the password to be used to access the ROAM wireless bridge. This defaults to @dmin51!!. This should only be changed if the wireless bridge has been separately reconfigured.
 
This setting specifies the password to be used to access the ROAM wireless bridge. This defaults to @dmin51!!. This should only be changed if the wireless bridge has been separately reconfigured.
−
=====Reset ROAM Config====
+
=====Reset ROAM Config=====
 
This button will reset the wireless ROAM bridge to the default configuration. WARNING: This will only work if the application is able to communicate with the wireless bridge. The wireless bridge can be reset directly if necessary.
 
This button will reset the wireless ROAM bridge to the default configuration. WARNING: This will only work if the application is able to communicate with the wireless bridge. The wireless bridge can be reset directly if necessary.
 
====ROAM Camera Config====
 
====ROAM Camera Config====
Line 99: Line 100:
 
This setting specifies the SSID for the wireless network.
 
This setting specifies the SSID for the wireless network.
 
=====Scan for Wireless Networks=====
 
=====Scan for Wireless Networks=====
−
[[File:ROAM_Manual_11.png]]
+
{{img - resize | file = ROAM_Manual_11.png}}
 
This button will scan for available wireless networks and allow you to select the appropriate one from a list, if you do not know the SSID.
 
This button will scan for available wireless networks and allow you to select the appropriate one from a list, if you do not know the SSID.
 
=====Authentication Type=====
 
=====Authentication Type=====
Line 135: Line 136:
  
 
===VALT===
 
===VALT===
−
[[File:ROAM_Manual_9.png]]
+
{{img - resize | file = ROAM_Manual_9.png}}
 
:Settings on this page are specific to VALT. An active connection to a VALT server is required for many features of the application.
 
:Settings on this page are specific to VALT. An active connection to a VALT server is required for many features of the application.
 
=====Server=====
 
=====Server=====
Line 151: Line 152:
 
=====Timeout=====
 
=====Timeout=====
 
This setting specifies the timeout for communications with the VALT server.
 
This setting specifies the timeout for communications with the VALT server.
 +
}}

Latest revision as of 14:29, 16 July 2025

Information

Settings

ROAM Manual 2.png

To access the settings page first click the gear icon in the bottom right.

ROAM Manual 3.png

You will be prompted to enter the password before you can access the settings menu. The default password is admin51.

ROAM Manual 4.png|link= ]]

Each of the settings sections can be accessed from the drop menu at the top of the screen.

Application

ROAM Manual 4.png

Settings on this page relate to the overall application.

Application Settings

Password

This setting specifies the password used to access the settings menu.

Orientation

This selects the orientation of the display. It defaults to automatic and will adjust the display based on whether the height or width are greater. It can be forcibly set to Landscape or Portrait mode.

Mode

Selects the operating mode for the application. For ROAM carts, this mode should always be set to Camera Control

Date/Time

Toggles the display of the date and time on or off. Defaults to On.

Buttons

Enabled buttons will be display on the righthand side in Landscape mode or in the status bar at the top of the screen in portrait mode.

Recording Button

Toggles the Recording Controls On or Off. This feature will only function with a VALT server.

Lock Button

Toggles the Room Locking Controls On or Off. This feature will only function with a VALT server.

Comment Button

Toggles the Comment Controls On or Off. This feature will only function with a VALT server.

Camera Control

ROAM Manual 5.png

Settings on this page are specific to the camera control application. These are utilized by the ROAM cart.
Stream Type

The setting allows you to select either an H264 or Motion JPEG stream. The H264 is smaller and contains audio. The MJPG stream is nearer to real time, but does not contain audio. The default should be MJPG for ROAM carts.

Resolution

This setting controls the size of the video stream pulled from the camera. For ROAM carts this should be 800x600.

FPS

This setting controls the frame rate of the video stream. For ROAM carts this should be set to 20 FPS.

Audio

This setting enables or disables video stream audio. It defaults to OFF. Audio will only work if using the H264 stream. For ROAM carts this should be set to OFF.

Keypad

ROAM Manual 6.png

Settings on this page are specific to the keypad application.
Pin Length

This setting allow you to configure the length of the pin code used to start and stop recordings. Each user must be assigned a unique pin code in VALT on this length. The default is 6 digits.

Smart Button

ROAM Manual 7.png

Settings on this page are specific to the Smart Button application. The smart button is design to be run in portrait mode.
Recording Button

Toggles the Recording Controls On or Off. This feature will only function with a VALT server.

Privacy Button

Toggles the Privacy Controls On or Off. This feature directly interfaces with the camera and does not require a connection to a VALT server, but the camera must support privacy masks.

Lock Button

Toggles the Room Locking Controls On or Off. This feature will only function with a VALT server.

Comment Button

Toggles the Comment Controls On or Off. This feature will only function with a VALT server.

System

ROAM Manual 10.png

Settings on this page are system wide settings.
Debug Mode

Toggles the default logging level from INFO to DEBUG, making additional information available in the logs.

View Logs

This button displays the last 100 log entries. Additional logs can be achived by accessing the logs folder from outside the application.

Factory Default

This button will delete the current configuration and reset all settings to the default values.

Exit Application

This button will exit the application.

ROAM

ROAM Manual 8.png

Settings on this page are specific to the ROAM cart. The ROAM cart is comprised of several devices with an internal network facilitating communication between these devices.

ROAM Bridge Config

The settings in this section allow the application to communicate with the ROAM wireless bridge. Under normal circumstances these settings will not need to be adjusted from defaults, however if you have reconfigured the wireless bridge, you will need to update the values in this section.

Enable ROAM

This toggle switch enables or disables ROAM mode. If enabled the application will attempt to detect the presense of a ROAM cart using the settings specified below. If enabled when not attached to a ROAM cart this may cause some lag on startup and shutdown of the application. This defaults to off, but must be enabled on all ROAM carts.

ROAM Internal IP

This setting specifies the IP address of the ROAM wireless bridge. The default address is 192.168.20.1. This should only be changed if the wireless bridge has been separately reconfigured.

ROAM Username

This setting specifies the username to be used to access the ROAM wireless bridge. This defaults to ivsadmin. This should only be changed if the wireless bridge has been separately reconfigured.

ROAM PAssword

This setting specifies the password to be used to access the ROAM wireless bridge. This defaults to @dmin51!!. This should only be changed if the wireless bridge has been separately reconfigured.

Reset ROAM Config

This button will reset the wireless ROAM bridge to the default configuration. WARNING: This will only work if the application is able to communicate with the wireless bridge. The wireless bridge can be reset directly if necessary.

ROAM Camera Config

The settings in this section allow the application to communicate with the ROAM camera. Under normal circumstances these settings will not need to be adjusted from defaults, however if you have reconfigured the camera, you will need to update the values in this section.

ROAM Camera IP

This setting specifies the IP address of the ROAM camera. The default address is 192.168.20.10.

ROAM Camera Username

This setting specifies the username to be used to access the ROAM camera. The default username is root.

ROAM Camera Password

This setting specifies the password to be used to access the ROAM camera. The default password is admin51.

ROAM WIFI Config

The settings in this section are used to connect the ROAM cart to your wireless network.

Radio Frequency

This setting specifies the wireless frequency to use. The default value is 2.4 GHz.

SSID

This setting specifies the SSID for the wireless network.

Scan for Wireless Networks

ROAM Manual 11.png

This button will scan for available wireless networks and allow you to select the appropriate one from a list, if you do not know the SSID.

Authentication Type

This settings specifies the authentication type for the wireless network. Choose the correct type for your wireless network. If selecting from a scan, this setting will be automatically populated.

Preshared Key

If using a pre shared key, enter the pssword in this box.

EAP Method

If using an EAP authentication type, select the appropriate EAP method.

EAP Username

If using an EAP authentication type, enter the EAP username.

EAP Password

If using an EAP authentication type, enter the EAP username.

Management Protection

This setting enables or disables the Management protection frame. The setting defaults to on. This setting must be disabled to ensure compatibility to certain wireless networks.

Apply Wireless Settings

This button will commit and apply the wireless settings. You must click this button after making changes.

ROAM WIFI IP Configuration

The ROAM WIFI connection defaults to DHCP. This setting can be changed to a static address instead.

ROAM WIFI IP

This setting specifies the IP address of the ROAM cart on your wireless network. This setting only takes effect if the WIFI is set to static.

ROAM WIFI IP Subnet Mask

This setting specifies the subnet mask of the ROAM cart on your wireless network. It must be specified using CIDR notation. This setting only takes effect if the WIFI is set to static.

ROAM WIFI IP Gateway

This setting specifies the default gateway of the ROAM cart on your wireless network. This setting only takes effect if the WIFI is set to static.

ROAM Wired Config

The settings in this section are specific to the wired network connection using a standard network cable.

ROAM Wired IP Configuration

The ROAM Wired connection defaults to DHCP. This setting can be changed to a static address instead.

ROAM Wired IP

This setting specifies the IP address of the ROAM cart on your network. This setting only takes effect if the wired connection is set to static.

ROAM Wired IP Subnet Mask

This setting specifies the subnet mask of the ROAM cart on your network. It must be specified using CIDR notation. This setting only takes effect if the wired connection is set to static.

ROAM Wired IP Gateway

This setting specifies the default gateway of the ROAM cart on your network. This setting only takes effect if the wired connection is set to static.

VALT

ROAM Manual 9.png

Settings on this page are specific to VALT. An active connection to a VALT server is required for many features of the application.
Server

This setting specifies the url of the valt server.

Username

This setting specifies the username used to access the VALT server. The application requires admin access, so this account must be a member of the Administrators group. It is recommended that a service account be created specifically for use by the application.

Password

This setting specifies the password for the selected account.

Recording Name

This setting specifies a default recording name to be used when a recording is started by the application.

Comment Name

This setting specifies a default comment to be used when a comment is created by the application.

Room

When connected to a valt server, this setting will display a dropdown list of all available rooms. Select the room in VALT correspond to this application instance.

Timeout
This setting specifies the timeout for communications with the VALT server.
Retrieved from "https://ipivs.info/wiki/index.php?title=ROAM_Manual&oldid=16336"