Developers
Documentation is coming
This is a placeholder, and it says so rather than filling itself with plausible-looking stubs. The developer documentation is not written yet. What follows is what exists today, what will be here, and how to get an answer in the meantime.
What exists today
The Bluetooth protocol is published and a free Swift SDK is on the way. That is the same commitment made on the rest of this site, and it is the reason this page will eventually be worth reading: a published protocol is what stops the receiver from becoming a walled garden later.
Until this page links the protocol document, ask for the current revision by email and you will get it, along with which firmware version it describes.
What will be here
Three sections, in the order a developer actually needs them:
-
Getting started
PlaceholderPair a receiver, confirm it is streaming, and read a position from your own code. The shortest path from an unboxed unit to a coordinate on screen.
Still to write: the pairing walkthrough, once the SDK API is stable enough that a code sample will not need rewriting monthly.
-
Receiver setup
PlaceholderMounting, antenna placement, the settings that matter and what each one costs you. The physical half of accuracy, which no amount of software fixes.
Still to write: the setup steps and every measured tolerance in them.
-
API
PlaceholderThe published Bluetooth protocol and the Swift SDK built on it: services, message formats, how corrections go in and positions come out.
Still to write: the protocol reference itself.
Each of these becomes its own page rather than a longer version of this one. Until then there is nothing behind them, and a link that goes nowhere is worse than no link.
In the meantime
Developer and SDK questions go to the same address as everything else, and they are answered by the person who wrote the firmware:
Worth saying in the first message: which platform you are building on, and whether you need to read positions, feed corrections, or both. That determines which half of the protocol you actually need and saves a round trip.
The guides are not developer documentation, but two of them cover the ground people usually arrive here looking for: inside the receiver for what the hardware does and refuses to do, and the iPhone guide for how position data reaches an app at all.