location: update all location docs to reflect new structure#467
Conversation
hasheddan
force-pushed
the
location/ga-updates
branch
from
5d11443 to
294a10c
Compare
|
Visit the preview URL for this PR (updated for commit a7222bb): https://golioth-docs-dev--pr467-location-ga-updates-22kpdokk.web.app (expires Fri, 22 Aug 2025 17:17:01 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f53b02bdc98ce6f5593931ec4c339aa96bac84df |
szczys
left a comment
szczys
left a comment
There was a problem hiding this comment.
Looks great, nice work!
I left 3 comments that you can take or leave.
| [Golioth Pipelines](/data-routing). For example, if tracking a device's location | ||
| over time is necessary, routing location to [LightDB | ||
| Stream](/application-services/lightdb-stream) or an external timeseries database | ||
| may be required. If it is necessary to make device's aware of their own |
There was a problem hiding this comment.
| may be required. If it is necessary to make device's aware of their own | |
| may be required. If it is necessary to make devices aware of their own |
| Golioth Location also offers built-in storage for the most recent device | ||
| position. Routing location information to the [`location` data | ||
| destination](/data-routing/destinations/location) will make it available for | ||
| visualization in `Location` section of the [Golioth |
There was a problem hiding this comment.
| visualization in `Location` section of the [Golioth | |
| visualization in the `Location` section of the [Golioth |
| | Attribute | Description | Required | | ||
| |------------|------------------------------------------------------------------------------------|----------| | ||
| | `type` | String indicating type of cellular network (`ltecatm` or `nbiot` | X | | ||
| | `mcc` | Integer indicating Mobile Country Code. | X | | ||
| | `mnc` | Integer indicating Mobile Network Code. | X | | ||
| | `id` | Integer indicating EUCID (LTE Cat-M) or Cell ID (NB-Iot). | X | | ||
| | `strength` | Integer indicating RSRP (LTE Cat-M) or NRSRP (NB-Iot). (dBm) | | | ||
| | `lac` | Integer indicating Tracking Area Code (TAC) | | | ||
| | `age` | Integer indicating age of measurement. (ms) | | | ||
| | `channel` | Integer indicating EARFCN. | | | ||
| | `serving` | Boolean indicate whether device is currently served by the cell. (default: `false`) | | | ||
| | `lid` | Integer indicating PCI (LTE Cat-M) or NCID (NB-Iot) | | | ||
|
|
||
| #### Wi-Fi Access Point Format | ||
|
|
||
| | Attribute | Description | Required | | ||
| |-------------|--------------------------------------------------------------------------------------------------|----------| | ||
| | `mac` | String indicating access point MAC address. | X | | ||
| | `ssid` | String indicating access point Service Set Identifier. | | | ||
| | `strength` | Integer indicating signal strength of access point (dBm). | | | ||
| | `age` | Integer indicating age of measurement. (ms) | | | ||
| | `frequency` | Integer indicating frequency of access point. (MHz) | | | ||
| | `channel` | Integer indicating channel number of access point. | | | ||
| | `Connected` | Boolean indicating whether device is currently connected to the access point. (default: `false`) | | | ||
|
|
There was a problem hiding this comment.
Do we want to add any info about what fields are required and what are optional? I ask because the example do not include all fields.
I'm also wondering if there should be more clarification about age. Is this ms between the reading and submitting them to Golioth or is this an epoch?
There was a problem hiding this comment.
Do we want to add any info about what fields are required and what are optional?
@szczys the last column indicates whether the field is required or not -- are you thinking we could restructure to make that more clear?
You also bring up a good point that it is probably worth at least adding a note that net_info support in the SDK can craft this for you.
I'm also wondering if there should be more clarification about age. Is this ms between the reading and submitting them to Golioth or is this an epoch?
age is the relative age of the measurement, so it would be more akin to the former. I can add a note to clarify 👍🏻
dylanswartz
left a comment
dylanswartz
left a comment
There was a problem hiding this comment.
Looks great! I appreciate the linking from the transformer to the application services section - i think it gives a good mental picture of how things fit together.
Updates all Golioth Location documentation to reflect its new structure ahead of General Availability. Devices now interact with Golioth Location via Pipelines, creating a much more flexible and robust solution. Signed-off-by: Daniel Mangum <georgedanielmangum@gmail.com>
hasheddan
force-pushed
the
location/ga-updates
branch
from
294a10c to
a7222bb
Compare
szczys
left a comment
szczys
left a comment
There was a problem hiding this comment.
Looks great, thanks for the additional context on required params and age!
3 participants
Updates all Golioth Location documentation to reflect its new structure ahead of General Availability. Devices now interact with Golioth Location via Pipelines, creating a much more flexible and robust solution.