LOCAL DRAFT
Custom package
A library contains a devTypes object keyed by device type name. Check messages are advice, not a
complete description of what this firmware accepts.
Identity & addresses
The object key identifies the type. If deviceType is supplied, it must match that key.
devInfoJson.type is metadata and can differ in existing profiles. New/Add controls accept 1–48
letters, digits, underscores or hyphens; LTR-390 is valid.
addresses lists I²C addresses or inclusive ranges, such as "0x29,0x30" or
"0x10-0x18". A Robotical device identified through WHOAMI can instead declare
deviceTypeId as an integer or a hex string such as "0x0084".
Some Add/Customise controls restrict system-profile names and addresses 0x36, 0x75 and 0x76. Current firmware rejects custom profiles containing 0x36 and treats 0x75–0x76 as mux addresses. Firmware also protects the required MAX17048 fuel-gauge profile. Other editor checks are advice for JSON written through other paths.
Detection & initialisation
detectionValues: "0x00=0x42" writes byte 00, reads one byte and expects 42. Prefer a
datasheet’s device identity register.
Join steps with & or ;. Bytes before = are the write. Detection
compares the returned hex value or a byte-aligned binary mask; x ignores a position in binary, not
hex.
Empty detectionValues matches on address alone. A custom profile is tried before compiled candidates,
so sharing an address does not prove the attached device is the intended model.
initValues runs when identification succeeds. Use whole-byte writes and explicit decimal
rN reads or pN millisecond pauses where supported by the parser. A pause needs
=: =p20 waits; a bare p20 is parsed as a write.
0x0001=p25 means write 0001, then wait 25 ms. The current Test controls omit that write, so their
verdict is unreliable for such sequences. Initialisation does not compare concrete expected values; put
identification checks in detectionValues.
Polling & response
pollInfo.c describes the poll sequence: "0x01=r2" reads two bytes after writing 01. The
AHT20 sequence "=r6&0xac3300=" reads the previous result and triggers the next measurement.
Advanced syntax is defined by the pinned Raft parser.
pollInfo.i is the saved polling interval in milliseconds; 100 means 10 polls per second. Applications
can override runtime polling. It is separate from publication frequency and any independently configured internal
sensor measurement rate.
pollInfo.s is retained samples, not delivery QoS. Leave polling absent for an actuator that is not
polled. devInfoJson.resp.b describes the response size and must agree with the poll layout; attribute
metadata supplies names, units and conversion rules.
The editor displays decoder metadata as JSON. Live readings discard decoder code supplied by a profile. RaftJS receives application-owned code only for an exact reviewed device-type and decoder-name pair; other profiles retain their ordinary metadata without supplying executable code.
Install, limits & recovery
The connected device reports its file and record limits. Browser grammar advice can be stricter than the firmware parser and does not block writing. The older fixed-read, 128-byte and 16-sample rules are not the current firmware library contract.
Saving changes only the local draft. Write to Axiom replaces the whole library file; Restart Axiom applies it. Removing the file restores built-in definitions only after restart. There is no trial or automatic rollback, and firmware can accept some records while rejecting others.
Remove a custom entry and restart to restore its built-in definition. {"disable": true} suppresses
that type.
Disable keeps a saved custom definition in the entry, and Enable restores it.
Byte counts use the same two-space-indented JSON that draft export and Write to Axiom send. The limit is measured over those exact UTF-8 bytes, including indentation and multi-byte characters. Templates and catalogue labels are not proof of compatibility or tested hardware behaviour.
Installing needs a connected Axiom.
Axiom is running your draft. Nothing to install. Change a device type or add a profile to start again.
-
The list compares your browser draft with the library file stored on Axiom now. Add and update describe changes to that file; remove a custom entry and restart to restore built-in defaults. Runtime lookup alone does not establish a built-in definition.
Reset draft from Axiom starts again from Axiom's current stored file. It changes only your browser draft.
-
ProfilesFile size
Writing replaces the whole library file and changes nothing else. Axiom keeps running its current definitions until it restarts. Export Axiom's library first if you may want the current file back; a firmware update also replaces it.
-
USB disconnects while Axiom restarts. If it does not come back, unplug and reconnect.
Technical details
The library file on Axiom
Not connected.
Device API responses
Not connected.
Remove the library
Deletes the library file and restarts Axiom with its built-in definitions. Your browser draft is kept.
Testing needs a connected Axiom.
The bus
Live Not scanned yet.From: “in stored library” means the profile is in Axiom’s current file; “on Axiom” means the device reports it but it is not in that file; “draft only” means it exists only in this browser’s draft. None of these proves which custom or built-in definition matched.
Status: claimed — a profile identified the device; unclaimed — something answers at that address but no profile claimed it; not detected — a draft profile expects a device there and the scan found none; no usable address — the profile gives no address to look at. A device can briefly drop out of a scan while readings run.
Raw bus state
Reported by Axiom as-is and not interpreted here.
Run a check to read the bus state.
Selected device
Select a row in the bus table.Select a device in the bus table to see its readings, change its polling, try a detection command or send it a write.
This direct or unsupported device has readings, but no bus polling, detection, or raw-write controls.
Temporary settings
These change Axiom now and are not saved. A restart returns the device to the interval and sample count in its descriptor. To keep a value, edit the descriptor and install it.
Try a detection command
Run a profile’s detectionValues against the selected device and see whether it answers as that profile expects. Nothing is installed and nothing is written to the library — this only asks the device the question the profile would ask.
Send bytes — acts on hardware
Exercise an actuator by writing bytes to the selected device. This drives real hardware as soon as you send it. The write is one-way — nothing is read back — so judge the result by what the hardware does.
Sends immediately to real hardware, after you confirm.
Community Catalogue
Not loadedAdding a profile copies it into your draft; nothing reaches Axiom until you install.
Installable means eligible to add as a custom profile under the current catalogue policy. It does not mean already installed or detected. Notes explain restrictions; address conflicts do not mean an external sensor is part of Axiom. Firmware can still reject a written profile at restart.
Shared profiles and setup documentation live in axiom-device-library on GitHub. Reviewed changes on main appear here after the service refreshes.
Community Catalogue source loads when you open this tab.
The catalogue loads when you open this tab.
Contribute a profile
Choose a profile from your draft
Only profiles that pass the Device Library's checks can be sent. Fix problems in Advanced JSON.
Describe the device
This becomes the profile's README, which people read before they wire anything up.
Test evidence
Nothing recorded for this profile yet. Connect your Axiom, then in Test & tune scan the bus, select the device and start readings. What it sees appears here and goes into the report.
Reports are public. A first name or username is enough.
Review and send
These are the files exactly as they will be added to the device library.
Pull request description
GitHub will ask you to let “Axiom Device Library” access your public repositories. It uses that only to copy the device library to your account and open this pull request, then gives the access back.
Request a device
Tell the community which sensor or actuator you would like Axiom to support.
GitHub opens in a new tab with your answers filled in. You need a GitHub account to post it.
Share what works with other Axiom users
Contribute a device profile, report how one behaves on real hardware, or ask for a device to be supported. You can send a profile or report from here; maintainers review it on GitHub before it reaches the Community Catalogue.
Contributions
These are the most recently updated pull requests in the public device library repository, refreshed from GitHub. Choose a device to see only the contributions that change its profile. Import to draft copies a profile from that pull request for local editing and testing. If several profiles are listed, choose one. Open and draft pull requests have not completed review; closed pull requests were not merged. A merge does not establish hardware compatibility. Writing to Axiom remains a separate step in Install.
Contributions load when you open this tab.
No contributions match these filters.
Showing the 100 most recently updated pull requests. View GitHub for older contributions.
Connect Axiom to see and manage its devices. You can browse the Community Catalogue without connecting.
Devices on this Axiom
Not loadedRecords in Axiom’s runtime type table, including custom and suppressed records. View a definition to customise it, or disable a profile you do not want detected. Changes take effect after Install and restart. “In stored library” refers to the current file, which may not be running yet. The firmware does not report whether each record is built-in. Possible I²C addresses come from each indexed definition (or the stored file for stored-only rows). They are alternatives or ranges, not detected sensors or physical ports. “—” means no addresses reported; “Unavailable” means the full record was not supplied. Use Test & tune to see connected devices.
Connect Axiom to see the device types it knows.
Repeated software restarts can intermittently leave USB unresponsive. Unplug and reconnect Axiom, then reconnect here and refresh. Never assume an interrupted command succeeded — read the device’s state back rather than inferring it. Close other tabs or serial tools using Axiom before connecting.
This page talks to Axiom over native Web Serial, so it needs desktop Chrome or Edge; connecting over Bluetooth is not supported. Libraries can also be shared as JSON files or imported from a CORS-enabled HTTPS URL. The firmware updater remains available from the top bar.