More admin docs ahead of updates

Author: addshore

.vitepress/config.mts

@@ -626,10 +626,17 @@ export default withMermaid(defineConfig({
                 { text: 'Permissions', link: '/apps/admin/authentication#permissions' },
               ]
             },
-            { text: 'Devices', link: '/apps/admin/devices' },
+            { text: 'Devices', link: '/apps/admin/devices',
+              items: [
+                { text: 'Actions', link: '/apps/admin/devices#actions' },
+                { text: 'Metrics', link: '/apps/admin/devices#metric-summary' },
+                { text: 'Timeline', link: '/apps/admin/devices#timeline' },
+              ]
+
+            },
             { text: 'Configs', link: '/apps/admin/configs' },
             { text: 'Users', link: '/apps/admin/users' },
-            { text: 'Invoice Audit', link: '/apps/admin/invoice-audit' },
+            // { text: 'Invoice Audit', link: '/apps/admin/invoice-audit' },
             { text: 'Plans', link: '/apps/admin/plans' },
           ],
         }

apps/admin/devices.md

@@ -5,7 +5,8 @@ outline: deep
 
 The default view is the device list, which shows all devices in the account.
 
-![](https://i.imgur.com/2Yok4An.png)
+![Lightbug Admin device list](https://i.imgur.com/pHBzHGL.png)
+
 
 ## Fields
 
@@ -36,21 +37,49 @@ Filters can be used to narrow down the list of devices.
 
 Such as all `ZeroN` devices.
 
-![](https://i.imgur.com/utUiBDm.png)
+![](https://i.imgur.com/JkdXTz6.png)
 
 ## Actions
 
-Some actions can be applied on a per device level, these all exist on the right hand side of the rows.
+The devices table has a number of actions that can be performed on devices, either in row actions, or via buttons on the right hand side of the rows, or via bulk actions having multiple devices selected.
+
+### In row actions
+
+Some actions are available on the device list itself, by interacting with various fields.
+
+#### Reveal ICCID & IMEI
+
+Click the `(more)` link in the identifiers column to reveal the ICCID and IMEI of the device.
+
+![](https://i.imgur.com/xoTN8ga.png)
+
+#### Set device name
+
+Hovering over a device name will reveal a pencil icon, which can be clicked to edit the device name.
+
+Hit `Enter` to save the new name, or `Escape` to cancel.
 
-![](https://i.imgur.com/389vSgB.png)
+![](https://i.imgur.com/22CIjYw.png)
+
+#### Schedule Firmware Update
+
+Clicking on the firmware version will open a dialog allowing you to schedule a firmware update for the device.
+
+![](https://i.imgur.com/sK66Th6.png)
+
+### Button Actions
+
+Some per device actions are available via buttons on the right hand side of the rows, these are:
+
+![](https://i.imgur.com/vOxhOLt.png)
 
 - Activate / Deactivate
-- Manage Users
+- [Manage Users](#manage-users)
 - Manage Settings
-- Display device information
-- Migrate
+- [See Device information](#device-information)
+- [Manage Forwarding](#manage-forwarding)
 
-### Manage Users
+#### Manage Users
 
 Clicking on the manage users icon will open a dialog allowing you to add or remove users from the device.
 
@@ -60,85 +89,141 @@ Users can have different global permissions, which can be controlled from the [u
 
 Clicking `Add User`, open an additional dialog allowing you to select a user from the list of users on your account, or create a new user.
 
-#### Add Existing user
+##### Add Existing user
 
 In order to select an existing user, click on their name from the list.
 
 ![](https://i.imgur.com/5aFeQlp.png)
 
 On success, you'll see a confirmation message in the top right corner.
 
-#### Add New user
+:::warning
+If the user already exists, and they are not a sub user of your account, you will not be able to select them.
+If this is the case please contact support to get them added to your account.
+:::
+
+##### Add New user
 
 To create a new user, click on the `Create New` button.
 
 This will open a dialog allowing you to enter the new users details.
 
-![](https://i.imgur.com/hKBzdYU.png)
+![](https://i.imgur.com/QEnoQwF.png)
 
 Once you have entered the details, click `Create` to create the user.
 
 On success, you'll see a confirmation message in the top right corner.
 
-#### Remove a user
+:::warning
+If the user already exists, you will not be able to create an account for them.
+:::
+
+##### Remove a user
 
 To remove a user from the device, click on the `X` icon next to their name.
 
-### Device information
+![](https://i.imgur.com/HBqlqN1.png)
+
+#### Device information
+
+Verbose information about the device, including:
+ - Overview: General device state information, and summarized device information over time.
+ - Timeline: A detailed timeline of data received from the device, and received by SIM providers.
+ - Config Pages: Current config pages applied to the device.
+
+![](https://i.imgur.com/GnwHbXd.png)
+
+##### Plan
+
+The top of the overview summarizes the current plan and billing state of the device.
+
+![](https://i.imgur.com/tIjgUsM.png)
+
+##### Metric Summary
+
+An expandable overview of some device metrics, errors, sends and power usage are then displayed.
+
+You can mouse over the graphs to see more details about the data.
+
+Use the `+1 Day` and `+1 Week` buttons to expands the time range of the graph into the past.
+
+![](https://i.imgur.com/alZiO0u.png)
+
+This data is then summarized further with some key metrics.
+
+- Total Time
+- Total Points
+- Avenge Signal
+- Average Points per transmit
+- Average Time Between Points
+- Average Time Between
+- Average Power per Transmit
+- Average Power per Point
+- Battery percent and voltage at start of the time range.
+- Battery percent and voltage at end of the time range.
+- Max battery voltage during the time range.
+
+And a breakdown of the source of locations received during the time range.
+
+![](https://i.imgur.com/oIgFTmS.png)
+
+##### Timeline
+
+The timeline shows a detailed view of events from and related to the device.
+
+This will poll for new events as they happen, so you should be able to see your device connecting and sending data when active.
 
-Verbose information about the device, such as the last known location, battery level, and more.
+![](https://i.imgur.com/WoevCJG.png)
 
-![](https://i.imgur.com/RmIDMBR.png)
+:::warning
+If your device has not recently sent any data, you might find the timeline empty, or timing out.
+:::
 
-Additional options are available for display:
+##### Config Pages
 
-- Show/Hide Log
-    - Show/Hide Info
-    - Show/Hide Status
-- Show/Hide latest points
-- Show/Hide attached config pages
+The config pages tab shows the current config pages applied to the device.
 
-#### Log
+You can remove config pages by clicking the `X` icon next to the config page name.
 
-Show meta data surrounding the submission of points.
+![](https://i.imgur.com/nrXrJW2.png)
 
-![](https://i.imgur.com/RBxExdU.png)
+#### Manage Forwarding
 
-You can toggle `Info` and `Status` from this list using the buttons.
+Forwarding is a new feature that allows you to forward data from your devices to other services, currently webhooks and MQTT.
 
-#### Latest Points
+![](https://i.imgur.com/zkPvShs.png)
 
-Shows some of the most recent [points](/terminology/points.html) for the device.
+This will replace similar messaging based on Notifications, which is only accessible via API or the [Cloud app](/apps/cloud/account/notifications).
 
-![](https://i.imgur.com/K7Js6XF.png)
+If you would like to use this feature, please contact support to get it enabled on your account, as it is not yet at General Availability.
 
-## Bulk actions
+### Bulk actions
 
 You can select multiple devices and perform actions on them by using the check boxes at the left of each row.
 
 ![](https://i.imgur.com/Y2LyH7r.png)
 
-### Export
+#### Export
 
 Exporting selected devices will display a modal allowing you to copy a IDs, Serial numbers, IMEIs or ICCIDs in a bulk format.
 
 ![](https://i.imgur.com/GiLWsY4.png)
 
-### Settings
+#### Settings
 
 Settings allows you to change the settings of multiple devices at once, making use of [config pages](./configs.html) that you have on your account.
 
 ![](https://i.imgur.com/MTQGSiH.png)
 
 <!-- TODO document "link device to this config" -->
 
-### Users
+#### Users
 
 Allows, bulk adding or removing of users from the selected devices.
 
 ![](https://i.imgur.com/KIweB1w.png)
 
-### Tags
+#### Tags
 
 Allows, bulk adding or removing of tags from the selected devices.
 
@@ -158,6 +243,6 @@ Tags can be:
  - Removed from all devices, using the bin icon.
  - Applied to all devices by clicking tags only applied to "Some devices" (in yellow).
 
-### Activate / Deactivate
+#### Activate / Deactivate
 
 Bulk activations and deactivations of devices.