Gen device msg menus from yaml

Author: addshore

Diff for: .vitepress/config.mts

@@ -1,16 +1,44 @@
-import { defineConfig } from 'vitepress'
-import { useSidebar } from 'vitepress-openapi'
-import { loadSpec } from '../swagger/load'
-import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
-import { pagefindPlugin } from 'vitepress-plugin-pagefind'
+import path from 'path';
+import fs from 'fs';
+import yaml from 'js-yaml';
+import { defineConfig } from 'vitepress';
+import { useSidebar } from 'vitepress-openapi';
+import { loadSpec } from '../swagger/load';
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs';
+import { pagefindPlugin } from 'vitepress-plugin-pagefind';
 
-const sidebarSpec1 = useSidebar({ spec: loadSpec(1) })
-const sidebarSpec2 = useSidebar({ spec: loadSpec(2) })
+// Load protocol messages from YAML file
+const protocolYamlPath = path.resolve(__dirname, '../public/files/protocol-v3.yaml');
+const protocolYaml = fs.readFileSync(protocolYamlPath, 'utf8');
+const protocolData = yaml.load(protocolYaml);
+
+// Generate menu items for protocol messages grouped by their respective groups
+const protocolMessages = protocolData.messages;
+const protocolGroups = protocolData.groups;
+const protocolMenuItems = Object.keys(protocolGroups)
+  .filter(groupKey => !protocolGroups[groupKey].hidden)
+  .map(groupKey => {
+    const group = protocolGroups[groupKey];
+    const items = Object.keys(protocolMessages)
+      .filter(key => protocolMessages[key].group === groupKey)
+      .map(key => ({
+        text: `${key}: ${protocolMessages[key].name}`,
+        link: `/devices/api/messages/${key}-${protocolMessages[key].name.toLowerCase().replace(/ /g, '-')}`
+      }));
+    return {
+      text: group.name || groupKey,
+      collapsed: true,
+      items: items
+    };
+  });
+
+const sidebarSpec1 = useSidebar({ spec: loadSpec(1) });
+const sidebarSpec2 = useSidebar({ spec: loadSpec(2) });
 
 // Function to make a sidebar group be collapsed
 function collapse(group) {
-  group.collapsed = true
-  return group
+  group.collapsed = true;
+  return group;
 }
 
 function reorder(group: { items: { link: string }[] }, orderedLinks: string[]) {
@@ -224,48 +252,7 @@ export default defineConfig({
             {
               text: 'Messages',
               link: '/devices/api/messages/',
-              items: [
-                {
-                  text: 'Generic',
-                  collapsed: true,
-                  items: [
-                    { text: '5: ACK', link: '/devices/api/messages/5-ack' },
-                    { text: '6: Keepalive', link: '/devices/api/messages/6-keepalive' },
-                  ]
-                },
-                {
-                  text: 'Device Services',
-                  collapsed: true,
-                  link: '/devices/api/messages/device-services',
-                  items: [
-                    { text: '30: Transmit Now', link: '/devices/api/messages/30-device-transmit-now' },
-                    { text: '31: GSM CFUN', link: '/devices/api/messages/31-device-gsm-cfun' },
-                    { text: '32: GSM IMEI', link: '/devices/api/messages/32-device-gsm-imei' },
-                    { text: '33: GSM ICCID', link: '/devices/api/messages/33-device-gsm-iccid' },
-                    { text: '34: Status', link: '/devices/api/messages/34-device-status' },
-                    { text: '35: ID', link: '/devices/api/messages/35-device-id' },
-                    { text: '36: Time', link: '/devices/api/messages/36-device-time' },
-                    { text: '37: Last Position', link: '/devices/api/messages/37-device-last-position' },
-                    { text: '39: RTK', link: '/devices/api/messages/39-device-rtk' },
-                    { text: '40: Haptics', link: '/devices/api/messages/40-device-haptics' },
-                    { text: '41: Temperature', link: '/devices/api/messages/41-device-temperature' },
-                    { text: '42: Buzzer', link: '/devices/api/messages/42-device-buzzer' },
-                    { text: '44: Pressure', link: '/devices/api/messages/44-device-pressure' },
-                  ]
-                },
-                {
-                  text: 'Device UX',
-                  collapsed: true,
-                  // link: '/devices/api/messages/device-ux',
-                  items: [
-                    { text: '10009: Text Page', link: '/devices/api/messages/10009-ux-text-page' },
-                    { text: '10010: Menu Page', link: '/devices/api/messages/10010-ux-menu-page' },
-                    { text: '10011: Bitmap', link: '/devices/api/messages/10011-ux-bitmap' },
-                    { text: '10013: Button Press', link: '/devices/api/messages/10013-ux-button-press' },
-                    { text: '10014: Screen Refresh', link: '/devices/api/messages/10014-ux-screen-refresh' },
-                  ]
-                },
-              ]
+              items: protocolMenuItems,
             },
             {
               text: 'Generate',

Diff for: devices/api/messages/10011-ux-bitmap.md renamed to devices/api/messages/10011-ux-draw-bitmap.md

@@ -4,14 +4,21 @@ limits:
   MAX_HEADER_FILED_LEN: 20 # As currently defined in Firmware
 groups:
   general:
+    name: General
     description: "General messages"
   bootserver:
+    hidden: true
+    name: Bootserver
     description: "Device to Boot server communication"
   livelink:
+    hidden: true
+    name: LiveLink
     description: "Device to LiveLink server communication"
   ondevice:
+    name: Device Services
     description: "On device communication (between CPUs)"
   ondevice-ux:
+    name: Device UX
     description: "On device communication (between CPUs), specifically for user interface and interactions"
 header:
   1:
@@ -72,7 +79,7 @@ header:
         name: "LORA Base Station"
 messages:
   5:
-    name: "General ACK"
+    name: "ACK"
     description: "General ACK message"
     group: "general"
     data:
@@ -85,7 +92,7 @@ messages:
         description: "ID of previous message being ACKed, if provided in the original message header"
         type: "uintn"
   6:
-    name: "General Keep Alive"
+    name: "Keep Alive"
     description: "General keep alive message"
     group: "general"
   10:
@@ -351,7 +358,7 @@ messages:
   #   group: "ondevice-ux"
   10009:
     name: "UX Text Page"
-    description: "UX text page"
+    description: "Display or change a text page"
     group: "ondevice-ux"
     data:
       3:
@@ -380,8 +387,8 @@ messages:
         name: "Line 5"
         type: "ascii"
   10010:
-    name: "UX Update Menu"
-    description: "Update UX menu"
+    name: "UX Menu Page"
+    description: "Display or change a menu page"
     group: "ondevice-ux"
     data:
       2: