Body Worn configuration file generator
The body worn web configuration can be found here:
Using the generator
Creating a new configuration
Open the web configuration
Set each of the settings as required, if you are unsure of a setting check this document or keep any default settings
Either:
Select “Generate and Copy to clipboard” The config will now be in the clipboard of the PC. This can now be pasted into Video Vault
Select “Generate and Download” The config will now be saved on the PC.
Updating an existing configuration
Open the web configuration
Either
Paste the existing setting into the config window
Select “Import JSON file” to open an existing config file
Set each of the settings as required, if you are unsure of a setting check this document or keep any default settings
Either:
Select “Generate and Copy to clipboard” The config will now be in the clipboard of the PC. This can now be pasted into Video Vault
Select “Generate and Download” The config will now be saved on the PC.
Settings and capabilities
Server
Server Address: The address of the EdgeVis server this device is to connect to
Allow secure connections: Requires crypto firmware to be installed on the device. Download the encryption pack from the EdgeVis server and upload to the configuration page.
Encoder name
By default, the system will use the encoder name configured against the user in video vault. However, the device name can be used as the EdgeVis Encoder name. To use this mode, enter the encoder password to use in the “Use device name as encoder name” field. All EdgeVis encoder must use the same password when using this mode.
Miscellaneous
Notification sound volume: The device volume to be set for device notification sounds
Settings Password: Set a password here to lock the device settings. If left blank the settings will not be locked
Silent mode on startup: Device will be in silent mode when undocked. In silent mode the device will not flash any LEDs or make any notification sounds
Enable Audio: Enable audio for any recordings and streaming. Audio needs to be enabled on the streaming profiles as well
Camera
The frames per second and frame size influences battery performance. Higher frames sizes and frame rates will reduce the overall battery performance.
Maximum FPS: The Frames per second to record. This also is the maximum fps the device can stream at
Maximum Width/Height: The maximum size of the video frame. This will be the frame size of the full resolution capability and the maximum frame size the device will stream at
Aspect Ratio: The aspect ratio to stream at. This does not affect the recording aspect ratio
Auto IR: Auto enable the IR lamps and camera when the light drops below a certain level. The IR lamps will affect battery performance
Recording
Enable recording on start: The device will start recording as soon as it’s undocked
Record while live streaming: The device will automatically start recording if the device starts to stream to remote viewing client. It will stop recording automatically when the streams stops
Recording mode: Determines what the device will do when the recording disk is full
Disk full alarm threshold: If the disk fills up, an alarm can be generated to inform a system administrator that the device disk is filling up
Maximum disk quota: Determines how much of the disk to use for recordings.
Show pre-recording indication: Show a pre-recording indicator on the device screen
Pre-recording duration: Device will pre-record for this duration. On pressing the record button the device will store the pre-recording duration to disk. Pre-recording will affect the battery performance of the device.
Record audio while pre-recording: While pre-recording the device can optionally record audio
Show post-recording indication: Show a post-recording indicator on the device screen
Pre-recording duration: Device will continue to record for a set time after the operator presses the stop recording button.
Archive encryption enabled: Recordings can be encrypted on disk. Requires crypto firmware to be installed on the device
Location
Enables GPS location data. Location data will be recorded on the device and sent to the EdgeVis server. Shorter update times will affect battery performance. We suggest no lower than 30 seconds.
APN
Leave these settings blank to use the default APN settings of the SIM card.
If setting a custom APN, the Name and APN fields must be set. The name is for information only. The Username and password are optional.
Roaming
Enable or disable cellular data roaming on the device. Requires version 7.2.12 and above. If this is not present in the config file the application will not change the current device setting.
Wi-Fi
Enable Wi-Fi on the device. When enabled, the Wi-Fi will be turned on when the device is assigned and undocked. An SSID and Password can optionally be added. If set, it will be added to the Wi-Fi list on the device. If there are multiple Wi-Fi configured on the device, it will not force the device to connect to this Wi-Fi.
Buttons
Configure the required action of each of the buttons on the device.
Bookmark: Set a bookmark on the recording. Bookmarks can be viewed in Video Vault
Toggle silent: Turn silent mode on. The LEDs will not illuminate and the device will not make any sounds
IR toggle: Toggle the IR lamps. This cannot be set when the Auto IR is enabled
Face Recognition: Run the face recognition algorithm on the camera and send faces to EdgeVis server. This requires the Face Recognition system
Recording Start Stop: Start and stop the recordings
Alert: Send an Alert to the EdgeVis server.
Disabled: Disable this button
LEDs
Set the operation of the device LEDs. A state with a higher priority will override a lower priority.
Available application events and groups:
Group | Event | Notes |
Recording | Pre-Recording | Device is currently pre-recording |
| Recording | Device is currently recording |
| Not Recording | Device is not recording |
Archive | Archive almost full | Disk is almost full as per the alarm threshold |
| Archive Full | Disk is full and no longer recording |
| Archive Ok | Disk is below the alarm threshold |
Connection | EdgeVis server disconnected | The device is not connected to the EdgeVis server |
| EdgeVis server connection | The device is attempting to connect to the EdgeVis server |
| EdgeVis server connected | The device is connected to the EdgeVis server |
Streaming | Streaming | The device is currently streaming to an EdgeVis viewer |
| Not Streaming | The device is not streaming to an EdgeVis viewer |
Battery | Battery Low | The battery is getting low |
| Battery not low | The battery is ok |
Application | Application running | The application is running. Can be used as a device is ON indication |
Panic | Panic | The user has operated the panic button |
Each group of settings can have a Priority and colour
Priority:, Low, Medium, High, Highest.
Colour: Red, Green, Flashlight
Each event can determine the state of the LED
Off, ON, Flashing Slow, Flashing Fast
For example, the Battery group can have a high priority, using the Red LED. With Battery not low set to OFF and battery low set to Flashing Fast.
Sound & vibration
Set the vibration and notification sounds to make. Not all devices support vibration.
Event | Notes |
Started Recording | Device has started to record |
Stopped Recording | Device has stopped recording |
Started pre-recording | Device has started to pre-record |
Archive almost full | Disk is almost full as per the alarm threshold |
Archive Full | Disk is full and no longer recording |
Archive Ok | Disk is below the alarm threshold |
EdgeVis server disconnected | The device has connected to the EdgeVis server |
EdgeVis server connection | The device is attempting to connect to the EdgeVis server |
EdgeVis server connected | The device has connected to the EdgeVis server |
Streaming | The device has started streaming to an EdgeVis viewer |
Not Streaming | The device has stopped streaming to an EdgeVis viewer |
Battery Low | The battery is low |
Battery not low | The battery is ok |
Application running | The application has started running. |
Panic | The user has operated the panic button |
Bookmark | The user has pressed the bookmark button |
Each event can either
Make a sound
Vibrate
Make a sound and vibrate
Connection profiles
Modify the TVI streaming settings for each connection profile. If you are unsure, leave the settings at the defaults
Support
Log Level: Only set if requested to by Digital Barriers support
Device Log: Set the device log frequency. Leave at 5 Minutes unless requested by Digital Barriers support. Device logs are uploaded to Video Vault when docked
Crash report: Only set if requested to by Digital Barriers support