New: the AI firewall watches every module and explains each incident in plain words. See how it works

The codec library

The 106 codecs that come with Hermetry – what sensor types they cover, how to find the right one, and how to test it.

Hermetry comes with a library of 106 codecs for common LoRaWAN sensors. Each one decodes the payloads of one sensor or a family of sensors from one maker. Devices on Automatic use the library without any setup when their maker and FPort match a library codec.

Open the library

  1. Open Devices.
  2. Open the ⋯ menu and select LoRaWAN codecs.

The drawer lists every codec you can use: the library’s (Source: Library) and your own (Source: Yours). You need the permission to view LoRaWAN codecs (users by default).

ColumnShows
IdThe codec id. Library ids are short names built from the maker and model. Your codecs start with t.
NameWhat the codec decodes, for example a temperature and humidity sensor
VendorThe device maker
ModelsThe model names the codec covers
FPortsThe FPorts it decodes; empty means every port
KindThe table format, tlv or layout
SourceLibrary or Yours
VerifiedVerified on a device or Not verified (decoded from the maker’s published format and checked against its test vectors)
Revision, Updated, StatusThe current revision, when it changed, Published or Withdrawn

Search by id, name, vendor, model or maker code (OUI).

What the library covers

Sensor typeExamples of values
Indoor air qualityCO₂, particulate matter, formaldehyde, ozone, temperature, humidity, pressure, light
Temperature and humidityRoom sensors, labels, probes (including PT100 and thermocouple transmitters), insertion and dual-probe sensors
Doors, windows and contactsOpen/closed state, open counts
Pulses and digital inputsPulse counters, input states
Electrical currentCurrent transformer clamps (single and three channel), multi-channel current sensors, smart sockets and meter plugs
Water leaksLeak detected, membrane and probe leak sensors
Level and distanceUltrasonic, radar and LiDAR distance, capacitive liquid level, submersible level, pressure and level transmitters, fill level
TiltTilt angle and tilt alarms
Soil and agricultureSoil moisture, temperature, conductivity (EC), pH, leaf moisture
Gas and odourGas detectors, odour detectors
Pressure and flowPipe pressure, flow meters
Weather and environmentWeather stations, light level, sound level
TrackingOutdoor asset trackers (GPS and Wi-Fi), container and card trackers, badges, contact-tracing tags
Buttons and alarmsPanic buttons, smart and wearable buttons, safety badges, scene panels
Occupancy and peoplePeople counters, desk and workplace occupancy, radar presence, fall detection, PIR motion
ParkingParking-space sensors
ControlSolenoid valve controllers, multi-interface controllers, light controllers, thermostats, radiator thermostats

There is no LoRaWAN vibration sensor in the library today. For a sensor that is missing, write your own codec.

Find the codec for your sensor

  1. Search the drawer for the sensor’s model name, as printed on it.
  2. Open the codec and check Models and FPorts.
  3. Check Makers (OUI): if your DevEUI starts with one of these six-digit codes, Automatic picks this codec by itself.
  4. If your DevEUI does not start with a listed maker code (for example, the supplier assigned its own DevEUIs), choose the codec by name on the device or profile.

A codec’s page

Open a codec from the list to see:

SectionShows
CodecId, revision, Fingerprint (SHA-256), models, FPorts, makers (OUI), origin and source
Keys it decodesEvery output key with its unit, taken from the codec’s own test vectors
RevisionsEvery published revision, with its size and number of keys
Test benchTry the codec with a real payload
The codec tableThe table itself (read-only for library codecs)

The page also reminds you: Downlinks are sent as raw hex or base64. Codecs decode only; see Sending downlinks.

Test a codec

  1. Open the codec and scroll to Test bench.
  2. Enter the FPort (1–255) and the Payload (hex) the device sent (spaces allowed, at most 255 bytes). Copy the payload from your device’s maker tool, or from a message decoded with None.
  3. Select Decode.

The bench shows the decoded Key, Value and Unit, any Warnings and Errors, and Bytes left over when the codec did not use all bytes. The codec did not recognise this frame. means the codec has no rule for this FPort or payload shape.

Output key names

Library codecs name their keys the way the device maker’s documentation names them, for example temperature_red or a text state such as "occupied". Different makers use different names for the same quantity. If you want one naming across your fleet, see Cleaning up decoded values.

Changes to the library

  • The platform updates the library over time. A new revision of a codec may add keys but never removes or renames one, and never changes a key’s unit. Your flows and dashboards keep working.
  • A codec can be Withdrawn by the platform. Devices that chose it decode with the automatic choice instead.
  • Library codecs are read-only for you. To change one, use Save a copy; see Write your own codec.