Refresh the share.chasm documentation

addshore · addshore · commit 92a266980801 · 2026-03-02T10:08:55.000Z
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -862,6 +862,21 @@ export default withMermaid(defineConfig({
           ],
         }
       ],
+      '/apps/chasm/share': [
+        { text: 'Chasm Share', link: '/apps/chasm/share/' },
+        { text: 'Creating a Share', link: '/apps/chasm/share/creating-a-share' },
+        { text: 'Views',
+          items: [
+          { text: 'Overview', link: '/apps/chasm/share/overview' },
+          { text: 'Summary', link: '/apps/chasm/share/summary' },
+          { text: 'Position', link: '/apps/chasm/share/position' },
+          { text: 'Satellite', link: '/apps/chasm/share/satellite' },
+          { text: 'Device Status', link: '/apps/chasm/share/device-status' },
+          { text: 'Power Info', link: '/apps/chasm/share/power-info' },
+          { text: 'BLE Scan', link: '/apps/chasm/share/ble-scan' },
+          ]
+        }
+      ],
       '/onprem': [
         {
           text: 'On Premise',
diff --git a/apps/admin/devices/sharing.md b/apps/admin/devices/sharing.md
@@ -32,4 +32,12 @@ The URL is made up of the device ID, start time, end time, and a random token to
 
 ## Viewing
 
-Shares will be published to [share.chasm.cloud](https://share.chasm.cloud) ([documentation](/apps/chasm/share/)), and can be viewed without authentication.
+Shares will be published to [share.chasm.cloud](https://share.chasm.cloud) which itself is [fully documented on this site](/apps/chasm/share/), and can be viewed without authentication.
+
+Some example share URLs for RH2 devices:
+ - [A 5 minute drive through Bristol @ 1Hz](https://share.chasm.cloud/#12916041/20260212-170900-20260212-171500-htNJ4Uuz5hM7zOb45Hw0)
+ - [A 50 minute walk in Bristol @ 1Hz](https://share.chasm.cloud/#12916041/20260212-124500-20260212-134500-5QoJIuLTbH76C9PlINmS)
+ - [Sat stationary on a rock on Dartmoor](https://share.chasm.cloud/#13671375/20260125-151718-20260125-152439-1EBYuf1nYgfqfDJ1lAVX)
+
+And for other devices:
+ - Android: [A 5 minute walk including BLE data](https://share.chasm.cloud/#13683726/20260114-164117-20260114-164627-OLlSHUMJvbY13z4TWtGZ)
diff --git a/apps/chasm/share/access.md b/apps/chasm/share/access.md
@@ -0,0 +1,11 @@
+## Access
+
+It's accessible at: [https://share.chasm.cloud](https://share.chasm.cloud), where users can enters a device ID, and unique share code to view any shared messages
+
+![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_lRFlmGNrRz.png)
+
+Shares can also be directly accessed via a URL in the format:
+
+```
+https://share.chasm.cloud#<device_id>/<share_code>
+```
diff --git a/apps/chasm/share/ble-scan.md b/apps/chasm/share/ble-scan.md
@@ -0,0 +1,25 @@
+# BLE Scans
+
+When BLE scan data is included in a share, it is shown in the BLE Scans section of the share page.
+
+## Map
+
+Positions of scans are inferred from the position of the device at the time of the scan, and are shown on a map when location data is included in the share.
+
+There are various filters that can be applied to reduce noise and find the data that is relevant to you, such as filtering by RSSI, or by device name.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_2vEit3u44G.jpg)
+
+## Over time
+
+Some summary graphs are also included showing the number of scans over time, and the distribution of RSSI values.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_2a0TlnN5AG.png)
+
+## Scan data
+
+Finally the scan data is displayed in a table at a per MAC address level.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_WvyZADmjEf.png)
+
+If you wish to see the raw scan data, you can download the messages at the top of the page, and process them to see the raw data.
diff --git a/apps/chasm/share/creating-a-share.md b/apps/chasm/share/creating-a-share.md
@@ -0,0 +1,13 @@
+# Creating a share
+
+## Admin portal
+
+Data can be shared from supported devices [via the admin portal](/apps/admin/devices/sharing) by selecting the share action for a device, choosing time periods, and message types to share, and then clicking the `Share` button.
+
+![](https://upload.r2.lb.chasm.cloud/2025/10/1qPepVy89y.png)
+
+## Message headers
+
+It is also possible to open up V3 messages to the share system by adding a custom header to the message when sending it to the chasm.
+
+For more information on how to do this, please contact us.
diff --git a/apps/chasm/share/device-status.md b/apps/chasm/share/device-status.md
@@ -0,0 +1,3 @@
+# Status
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_suH108V764.png)
diff --git a/apps/chasm/share/index.md b/apps/chasm/share/index.md
@@ -6,40 +6,12 @@ The Chasm Share application is a web-based tool that allows users to view public
 
 <DeviceCompatibilityV3 fullWidth/>
 
-## Access
+Upon access, you'll be presented with a form to enter a device ID and share code, which are generated when [creating a share](./creating-a-share).
 
-It's accessible at: [https://share.chasm.cloud](https://share.chasm.cloud), where users can enters a device ID, and unique share code to view any shared messages
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_ZVCEQhVHsC.png)
 
-![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_lRFlmGNrRz.png)
+If you are accessing a share via a valid direct URL, you will end up on the share view page, which displays the shared data.
 
-Shares can also be directly accessed via a URL in the format:
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_j7qoWf3Ehb.png)
 
-```
-https://share.chasm.cloud#<device_id>/<share_code>
-```
-
-## Sharing data
-
-Data can either be shared via the [Admin portal](/apps/admin/), or by adding a share code directly to messages sent to the default device link.
-
-## Viewing Data
-
-Once a valid device ID and share code are entered, the application displays the shared messages in a user-friendly format.
-
-The top of the page shows the share details, as well as links to download the shared data in a variety of formats: JSON, CSV, KML (track, points, or both), NMEA, V3 Messages (Hex, Base64)), Map PNG
-
-![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_8TplfstA3F.png)
-
-If the share includes [Position Messages](/devices/api/messages/15-position), the application will display a map with the recorded positions.
-
-![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_FCYPD20psZ.png)
-
-Additional information about the GNSS status is also displayed in a variety of charts.
-
-This comes from both [Position messages](/devices/api/messages/15-position) and [Satellite Data message](/devices/api/messages/16-satellite-data)
-
-![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_5LMFu0hGut.png)
-
-At the very bottom of the page, all messages are displayed in their JSON format, which is a human readable translation of the raw binary data sent by the device (V3 Messages).
-
-![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_8vEOMkBnUk.png)
+The various views of the shared data are documented in the following pages of this section.
diff --git a/apps/chasm/share/overview.md b/apps/chasm/share/overview.md
@@ -0,0 +1,24 @@
+# Viewing Data
+
+Once a valid device ID and share code are entered, the application displays the shared messages in a user-friendly format, split into various sections.
+
+Multiple shares can be loaded at once, and remembered, which will display as tabs across the top of the screen.
+
+## Overview
+
+The first section includes an overview of device and share information, as well as links to download the shared data in a variety of formats.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_hqSioXjX9T.png)
+
+The download options are:
+ - All messages
+    - JSON: One JSON object per message, with human readable field labels, parsing and formatting of values
+    - CSV: One column per V3 message field label
+    - HEX: Raw V3 message data in hexadecimal format
+    - Base64: Raw V3 message data in Base64 format
+ - Positions:
+    - KML (track, points, or both)
+    - NMEA
+    - MAP PNG (when locations are included)
+
+Formats may or may not be available depending on the type of shared data.
diff --git a/apps/chasm/share/position.md b/apps/chasm/share/position.md
@@ -0,0 +1,29 @@
+# Position
+
+## Map
+
+Based on the position messages received, a map will be shown with various options.
+
+The **marker every** option will populate to a sensible default value s as to not overload the map, but can be adjusted to show more or fewer markers.
+
+**Overlay all routes** can be used to show all routes from all currently open shares on a single map.
+
+**Show accuracy** will show circles around each marker to indicate the rough accuracy of the position, based on the `accuracy` field of the position messages.
+
+### Static RTK device
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_lirUXmsq5e.png)
+
+### In motion RTK device
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_sUTV5HWK9m.png)
+
+### Android phone
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_OGxywyDCyz.png)
+
+## Graphs
+
+Various parts of position messages are then also plotted on graphs when available, such as the number of satellites, and the accuracy.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_oiCLSyUxPx.png)
diff --git a/apps/chasm/share/power-info.md b/apps/chasm/share/power-info.md
@@ -0,0 +1,3 @@
+# Power info
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_0S5Qxzgzx7.png)
diff --git a/apps/chasm/share/satellite.md b/apps/chasm/share/satellite.md
@@ -0,0 +1,5 @@
+# Satellite Data
+
+Various parts of satellite data from satellite messages when included in the share.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_mJaFGoktZZ.png)
diff --git a/apps/chasm/share/summary.md b/apps/chasm/share/summary.md
@@ -0,0 +1,19 @@
+# Summary
+
+## Overview
+
+The first section of the summary includes graphs showing the overall and per message type message rates.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_0Lb5bpk6HX.png)
+
+## Statistics
+
+There is then also a breakdown of the various message types, when the first and last message of that type appears in the share, a total count and overall average frequency.
+
+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_i40urnq6cI.png)
+
+## Raw Messages
+
+At the very bottom of the page, all messages are displayed in their JSON format, which is a human readable translation of the raw binary data sent by the device (V3 Messages).
+
+![](https://upload.r2.lb.chasm.cloud/2025/10/chrome_8vEOMkBnUk.png)
diff --git a/components/DeviceCompattbility/DeviceCompatibilityV3.vue b/components/DeviceCompattbility/DeviceCompatibilityV3.vue
@@ -17,9 +17,9 @@ const props = defineProps({
 })
 
 const devices = [
-  { id: 'rtk-handheld', name: 'Handheld RTK', link: '/devices/rtk/handheld/' },
-  { id: 'rtk-vehicle', name: 'Vehicle RTK', link: '/devices/rtk/vehicle' },
+  { id: 'rtk', name: 'RTK', link: '/devices/rtk/' },
   { id: 'viper', name: 'Viper' },
+  { id: 'ble-gateways', name: 'BLE Gateways' },
   { id: 'zcard', name: 'ZCard' }
 ]
 </script>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Status`
	`2`	`+`
	`3`	`+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_suH108V764.png)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Power info`
	`2`	`+`
	`3`	`+![](https://upload.r2.lb.chasm.cloud/2026/03/chrome_0S5Qxzgzx7.png)`