Applies to Android version 2026.02
Unity is a configurable end user application that can be customised to specific deployment requirements. The following defines the configuration options available.
Note: The Unity app must first be installed onto the device from the App Store or Play Store. If these are not available on the device, see how to install when no play store is available.
General configuration (all modes)
| Key | Values (default) | Description |
|---|---|---|
| Device_Culture | Culture code, e.g. en-GB | Sets the app culture. The app restarts to apply it. |
| Device_Time_Format |
1 = 12-hour any other value = 24-hour |
Time format throughout |
| Device_Update_Mode | 1 = on (default is 1) |
Live SignalR event updates: Polled = 0 Event driven = 1 |
| Device_No_Web_Browser | 1 = off | Disables links that open a web browser |
| Device_Debug_PinCode | text | PIN for the debug menu |
| Device_Accent_Colour_Light / _Dark | HEX colours | Accent colour per theme; used only when both are set |
| Device_OEM_Mode |
0 IBSS logo only 1 client + IBSS logo 2 client + custom brand logo |
|
| Device_OEM_Client_ImageURI | URL | Client logo. The app fetches its -light / -dark variant |
| Device_OEM_Brand_ImageURI | URL | Brand logo, used only with the OEM mode 2 |
| Device_Auth_Error / Device_General_Error | text | Replaces the default error messages |
| Device_Brightness_Timeout | seconds (60; 0 also gives 60) | Time without a touch before the screen dims to the low brightness |
| Device_Brightness_High / _Low | 0–1 (0.75 / 0.35; 0 also gives these defaults) | High and low screen brightness |
| Device_Degrees_Fahrenheit | >0 = °F, otherwise °C | Temperature unit in Room Control |
| Signage_Orientation | 0 follows the device, 1/4 landscape, 2/8 portrait |
Which layout is used:
|
| ImageURI | URL |
Path to custom background image. Supported resolution limit is 640 × 360 pixels (16:9). Format: PNG or JPG. |
Unity configuration options
| Setting name | Values | Description |
|---|---|---|
| Booking_Mode | 0 off, >0 on |
|
| Authentication_Mode | 0 email + PIN, 1 none, 2 email + PIN or card, 3 card only | How users sign in |
| NFC_DeviceType | 0 generic NFC, 1 HID | Card reader type; the reader only runs with mode 2 or 3 |
| NFC_Mode | bitmask: 1 book, 2 check in, 4 check out (absent = 5) | What a card tap does; read only with Authentication_Mode 2 or 3 |
| Enrolment_Mode | >0 = on | Adds Register (card enrolment) to the burger menu |
| Book_Now_Max_Duration | minutes (60) | Sets the maximum duration for the booking. Paired with the Repeating start and end time interval that is set in the booking policy, corresponding booking slot options are then displayed to the user when they start a booking on Unity. |
| Schedule_SlotSize | minutes; 0 or >240 → 30, <15 → 15 |
This setting defines the length of the box that appears on the Unity timeline as a bookable slot, in minutes. Min. value = 15 Max. value = 240 ⚠️ Align this value with the minimum bookable duration that is defined for this space by the associated booking policy. |
| Booking_Confirmation_Delay | milliseconds (500), clamped 0–5000 | How long a booking can take before the processing dialog appears |
| Booking_Confirmation_Timeout | seconds (10), clamped 3–60 | How long that dialog waits for SignalR to confirm the booking |
| Show_Room_Booking_Checkout | 0 hidden, 1 no sign-in, 2 host PIN (not needed for Book Now bookings) |
This setting applies to the Unity - Outside room mode. 0 = False (don't allow it) (default) |
| Hide_Room_Booking_Name | 0 shows names, anything else shows “Booking” |
This setting applies to the Unity - Outside room mode. 0 = Don't hide booking name (default) 1 = Hide booking name |
| Display_Mode_Margin | thickness, e.g. "20" or "10,20" | Margin around the Display mode image |
| Colour_DeviceType | 10/11 iAdea, 20/21 ProDVX RGB, 30/31 ProDVX GPIO, 40 ProDVX API, 50 Yealink |
Defines a mode for difference hardware LED configurations: 10 = IAdea_Type1 (XDS-1078-A12) 11 = IAdea_Type2 20 = ProDVX_RGB_Type1 21 = ProDVX_RGB_Type2 30 = ProDVX_RG_Type1 31 = ProDVX_RG_Type2 40 = ProDVX APPC-10S as mentioned in Unity OS and Hardware Requirements 50 = Yealink devices |
| Colour_Settings_Enabled | 1 = on |
Whether to override the default colour settings: 0 = No 1 = Yes See optional 'Colour_Settings' for overrides |
| Colour_Settings | 1 = on | LED_Enabled = true/false LED_Unavailable = Hex colour as #XXXXXX LED_RestrictedAvailability = Hex colour as #XXXXXX LED_Available = Hex colour as #XXXXXX LED_RequiresService = Hex colour as #XXXXXX LED_OutOfService = Hex colour as #XXXXXX |
| ProDVX_API_Type | 1 = API v1 (the only value handled) | Turns on the ProDVX API; needs the token |
| ProDVX_API_Token | text | ProDVX API token |
| ProDVX_API_Settings.API_BaseAddress / API_Port | localhost / 3535 | ProDVX API address |
| Background_settings.Show_Background_Image | True or false to show or hide the background image that's been uploaded for a specific space. | |
| Background_Settings.Gradient_Color_Light_A / _B, Gradient_Color_Dark_A / _B | HEX colours |
Background gradient for each theme:
|
| Background_Settings.Gradient_Type | 0 radial, 1 linear | Gradient shape |
| Background_Settings.Gradient_Invert |
false True to allow inversion of gradient points A and B |
Reverses the gradient |
| Background_Settings.Gradient_Color_Position_A / _B | 0.35 / 1 |
Gradient stop positions. Floating value between 0 and 1 for:
|
Unity configuration example
{
"Device_Update_Mode": 1,
"Device_Culture": "en-GB",
"Device_OEM_Client_ImageURI": "https://icoukibssstgstore.blob.core.windows.net/images/r/OEM/ClientImages/CompanyTest.png",
"Device_OEM_Brand_ImageURI": "https://icoukibssstgstore.blob.core.windows.net/images/r/OEM/SubBrandImages/BrandTest.png",
"Device_Auth_Error": "Please contact the nearest reception staff. Error Code 1.",
"Device_General_Error": "Please contact the nearest reception staff. Error Code 2.",
"Device_OEM_Mode": 0,
"Device_Degrees_Fahrenheit": 0,
"Signage_Mode": 0,
"Signage_Orientation": 1,
"ImageURI": "",
"Device_Brightness_Timeout": 5,
"Device_Brightness_High": 0.5,
"Device_Brightness_Low": 0,
"Unity": {
"Show_Room_Booking_CheckOut": 1,
"Booking_Mode": 2,
"Book_Now_Max_Duration": 60,
"Colour_DeviceType": 50,
"Colour_Settings_Enabled": 0,
"Colour_Settings": {
"LED_Enabled": 1,
"LED_Unavailable": "#FFFF0000",
"LED_RestrictedAvailability": "#FFFFFF00",
"LED_Available": "#FFFF0000",
"LED_RequiresService": "#FFFF00FF",
"LED_OutOfService": "#FFC0C0C0"
}
}
}