How does an integration work?

This article explains how integrations work in BriqSafe by describing the process of registering, placing, linking, and managing IoT sensor devices. It is intended for engineers and administrators involved in setting up and maintaining monitoring sensors within the system.

Note

Required role: Engineer

Prerequisites for IoT Device Integration

Before working with IoT device integrations, ensure that:

• Your organisation has the integrations entitlement activated, which requires a gold-and-above plan.
• The IoT Devices feature toggle is enabled for your organisation; otherwise, device-related screens will show a Coming Soon message.
• You have the necessary permissions to link devices, as Add Device and Place Device actions are shown only to users who can link devices.

Registering a FactoryLab Sensor without Immediate Placement

Register a new FactoryLab sensor by selecting its source and model without placing it on an asset right away.

1. Open IoT Devices from the organisation menu.
2. Click Add Device.
3. On the Select Device Source page, choose FactoryLab and click Next.
4. On the Select Device Model page, choose either ClipR or ClipR Flex.
5. Complete the Add FactoryLab Device form with the required details to register the device.

Note: The Other Provider option is not available and shows Coming Soon. Only FactoryLab devices can currently be registered.

Important: Registering a device does not link it to an asset. Use Place Device or the device's Link Device action to attach it before it can feed data into jobs.

Placing and Linking a Sensor Device on an Asset

Attach a registered sensor to the specific asset it will monitor for ongoing measurement.

1. Open IoT Devices and select Place Device.
2. In the Device Identifier field, paste the QR code data or type the 16-character DevEUI. The system will indicate Valid DevEUI once properly entered.
3. Click Next.
4. Choose the Site, then the Asset, and select the Water Type (such as Cold, Hot, Mixed, or Return pipe) for temperature devices.
5. Click Confirm Placement, then Place Device.

A confirmation toast saying Device placed successfully! confirms the device is registered and linked to the asset.

Notes:

• The web wizard does not support camera scanning; you must paste or type the DevEUI. Camera scanning is available only via the mobile app.
• If the device is already placed elsewhere, the option to Relocate Device will appear instead of placing a new link.
• A DevEUI already registered in your organisation is reused; no duplicates are created. If it belongs to another organisation, registration halts with an error message.
• LoRaWAN devices start reporting only after their first uplink, so readings may not appear immediately after placement.

Linking a Device to an Asset and Mapping Sensor Entities

Attach a device to an asset and map each sensor entity to the specific compliance parameter it measures, enabling automatic job filling.

1. From the IoT Devices list, open the device to link.
2. In the Linked To card, click Link Device and select the target asset.
3. After linking, the Sensor Mappings section appears.
4. For each device entity (e.g., temperature sensor), click Map and select the corresponding BriqSafe compliance parameter.
5. Set the staleness threshold, which defaults to 24 hours; this defines how old a reading can be to auto-fill a job.
6. Save the mappings.

Notes:

• A device can link to only one target at a time (asset, area, or system).
• Only mapped sensor entities can auto-fill scheduled jobs. Unmapped entity readings appear in charts but do not complete jobs automatically.
• The staleness threshold prevents outdated readings from triggering job completion.

How Sensor Readings Auto-Complete Scheduled Jobs

Mapped sensors automatically fill compliance parameters for open jobs linked to their asset without manual data entry.

When a scheduled job for an asset is Pending or In Progress and requires parameters measured by linked sensors, the freshest reading within the staleness window auto-fills the job parameter. The job status updates accordingly:

• If all required parameters are filled, the job status becomes Completed.
• If only some parameters are filled, it remains In Progress.
• If none are filled (all readings missing or stale), the job stays Pending.

Each parameter fill records the reading's value, unit, and timestamp as provenance.

Important: The job status reflects progress (Pending, In Progress, or Completed), not compliance. Evaluation of threshold breaches is handled separately by rules.

Reviewing Devices and Sensor Readings

Inspect device details and historical sensor telemetry to understand device status and reading trends.

1. Open the device from the IoT Devices list.
2. Review the info card showing DevEUI, Type, Source, manufacturer, model, battery, and signal status.
3. See the linked asset, area, or system in the Linked To card.
4. Select any sensor entity from the left-hand list to display its readings chart showing aggregated minimum, maximum, and average values over a selectable time range.
5. Click Refresh to update the device detail and readings chart.

Notes:

• A device with no transmissions yet shows a Pending status and a troubleshooting panel instead of a chart.
• The device status indicates connectivity (Online, Offline, Pending, or Unknown), not compliance.
• The readings chart is read-only and does not show thresholds or alerts.

Managing Device Details, Unlinking, and Relocation

Update device information, detach devices from assets, or move them to new assets as needed.

1. Open the device from the IoT Devices list.
2. Click Edit to change the device's name (3 to 100 characters) and type inline, then Save.
3. To detach the device from its asset, use Unlink in the Linked To card.
4. Alternatively, use Place Device again to relocate the device to a different asset.

Notes:

• Unlinking preserves sensor mappings, so relinking later does not require remapping each entity.
• Deleting devices requires Manager role or higher and is hidden for lower roles.

Browsing All Devices Across Your Organisation

Access a consolidated list of all IoT devices registered within your organisation for review and management.

1. Open IoT Devices from the organisation menu.
2. Use the search box and filters for Status (Online, Offline, Pending, Unknown) and Type to locate specific devices.
3. View device details within the list, including name, type, status, battery, signal, last seen, and linked asset.
4. Click a device row to open its detailed view.

Note: Pending status means the device is registered but has not transmitted any data yet, not an error.