Skip to content
English
Request Support Customer Portal
Customer Portal
  • There are no suggestions because the search field is empty.

Yarn Commissioner - Full User Guide

How to use the Yarn Commissioner app Detailed User Guide

Overview

Yarn Commissioner is the mobile tool to discover, connect, validate, and commission Yarn devices into your Yarn Mesh network and IMS. It replaces the legacy Yarn Companion with a faster, cleaner UI and a live terminal for diagnostics.

Supported devices: TrailCam, TrapNode, Relay, WeatherStation, TankNode, and other approved Connected Devices.

1. Prerequisites

  • Android or iOS phone with Bluetooth enabled.
  • Yarn Commissioner app installed (latest version).
  • Device powered on and in Bluetooth advertising window (first ~30 minutes after device power-on/reset).
  • You are within 5 metres of the device.
  • Yarn Mesh coverage present at install location (or within range of a commissioned Yarn Mesh device preferably a Relay).

2. App Interface

App Icon (Launch App)

  • Open the Yarn Commissioner app on your phone, the app icon looks like this:

Global Controls

  • Search & Scan Icon (scan for active BLE devices)

  • Overflow menu (About, Help, Logs, Settings) 

  • Bluetooth scan button (bottom-right) to start/stop scanning

Home Screen (Device List)

  • Scan/Search Buttons (scan for Bluetooth/BLE devices nearby)

  • Status (Scanning for BLE devices)
  • Device List (Yarn device type (e.g., Uncommissioned TrailCam), EUI64 (device unique identifier e.g.  f4ce .... .... )  & BLE signal strength (e.g., Good/Okay/Poor)

a. 

b.

c.


3. Connecting to a Device

  1. Ensure Yarn device is powered and advertising BLE (first ~30 minutes after device power on/reset).

  2. Open Yarn Commissioner app

  3. Tap Scan or Search button. 

  4. Tap Connect on the device card.

  5. Status shows CONNECTED when link is active.

  6. A green banner confirms message exchange, e.g., Data received: 20 chars.

Connecting

Connected

  

4. Health Checks Explained

After connecting, the app runs built-in checks:

Mesh Health

  • Shows number of Mesh Neighbours, link quality, routing state.

  • Amber usually means marginal link or test still in-progress.

Battery Health

  • Verifies voltage, internal pack state, and availability.

  • If red: inspect wiring, ensure the solar charger is connected (if used), or charge batteries.

Sensor Health

  • Runs device-specific tests: camera responsiveness, PIR, IO, etc.

  • Red may indicate missing SD card or sensor not responding.

TrailCam Commissioning Issues

TrapNode Commissioning Issues

All Tests Green

READY TO COMMISSION

 

5. Commissioning a Device

Commissioning registers a device in the Yarn Mesh backend & IMS or Faarm and applies standard device type templates.

Steps:

  1. Wait for health tiles to complete.

  2. Tap Commission.

  3. Enter a Device Name (becomes the IMS Asset Name).

  4. Tap Commission again to confirm.

  5. The device is marked as commissioned and will show its name next time.

 

 

  

 

Naming Tips:
Use a scheme that encodes type/region/number, e.g., PFYM_TC_NorthRidge_018.

6. Terminal Mode (Advanced)

Tap Open Terminal to issue direct commands:

  • sensor get board_voltage

  • ot neighbour table

  • ot router table

  • ot state

  • prox_fake

Export Logs: Use system share from the terminal header to send logs to FTP Support.

 

 

Caution: Commands may affect runtime. Use with FTP Support guidance.

7. Best-Practice Commissioning Flow (Field)

  1. Pre-check: Confirm Yarn Mesh coverage in the area (IMS Wireless Manager plan + on-site verification).

  2. Power & BLE: Boot the device; confirm BLE is advertising.

  3. Scan & Connect in Yarn Commissioner.

  4. Validate health: Mesh Health Green, Mesh ≥1 neighbour; Battery green; Sensor green.

  5. Commission and name consistently.

  6. Verify telemetry in IMS (image/event/metrics appear, where applicable).

  7. Secure install: Finalise mounting, align, weatherproof, tidy cables, screenshot of commissioning data.

8. Common Issues & Fixes

  • BLE Signal: Poor → Move closer; ensure no metal shielding; avoid bodies between phone/device.

  • Mesh Health amber/red → Reposition nearer to a Relay; add a Relay; check antenna angle; clear vegetation line-of-sight where possible.

  • Battery Health red → Charge device or battery pack; reseat battery; verify voltage with a multimeter; change battery.

  • Solar Health red → Check solar panel connectors; verify voltage with a multimeter; change solar panel.

  • Sensor Health red → For TrailCam, confirm SD card and power switch moved from SETUP to ON position (far left position); for TrapNode, verify trap I/O lead and trap controller status; for WeatherStation, check RS485 lead and polarity; for LevelSensor ensure ultrasonic sensor is not obstructed.

  • Trap AT520 Health red → For TrapNode, inside trap confirm M12 plug between AT controller and TrapNode; 

9. Device-Specific Notes

Relay

  • Mount high, clear of foliage where possible; verify ≥2 neighbours are Relays in dense networks if you can.

TrailCam

  • Ensure SD card installed before boot.

  • Post-commissioning, images are sent over Yarn Mesh to IMS (auto-classification per roadmap).

TrapNode

  • Verify trap comms link (e.g., AT520-AI) shows healthy in Sensor Health before commissioning.

WeatherStation (RS485)

  • Confirm Modbus address and wiring (A/B) before Sensor Health test.

LevelSensor

  • Check level sensor reference and calibration; confirm stable readings after siting.

10. Safety,  Updates & Quality

  • Apply OTA updates when prompted.

  • Keep device enclosures sealed and cables strain-relieved.

  • All provisioning uses secure channels; device identity is unique to each unit.

11. Support

  • Email: support@yarnmesh.ai

  • Include: device type, device name, project/site, screenshots, and steps taken.c