Publish official XPF map previews

.github/workflows/pages.yml

@@ -32,7 +32,7 @@ jobs:
         run: |
           mkdir _site
           cp index.html catalog.json robots.txt sitemap.xml .nojekyll DISCLAIMER.md DATA_LICENSE.md _site/
-          cp -R assets data maps schemas _site/
+          cp -R assets data maps pages schemas _site/
       - uses: actions/configure-pages@v5
       - uses: actions/upload-pages-artifact@v3
         with:

assets/app.js

@@ -72,9 +72,17 @@
     const links = document.createElement("div");
     links.className = "card-links";
     links.append(
-      createLink("Open JSON", item.json_url, "json-link"),
-      createLink("Device guide", item.documentation_url, "docs-link")
+      createLink("View preview", item.preview_url, "docs-link"),
+      createLink("Open JSON", item.json_url, "json-link")
     );
+    if (item.guide_status === "published" && item.documentation_url) {
+      links.append(createLink("Device guide", item.documentation_url, "docs-link"));
+    } else {
+      const guide = document.createElement("span");
+      guide.className = "guide-badge";
+      guide.textContent = "Guide upcoming";
+      links.append(guide);
+    }
     card.append(top, title, description, categories, links);
     return card;
   };

assets/styles.css

@@ -95,6 +95,22 @@ h2 { font-size: clamp(2.1rem, 4.3vw, 3.65rem); }
 footer { min-height: 110px; display: flex; justify-content: space-between; align-items: center; gap: 2rem; border-top: 1px solid var(--line); color: #829ba4; font-size: .76rem; }
 footer div { display: flex; gap: 1rem; }
 
+.guide-badge { align-self: center; border: 1px solid #8193a1; border-radius: 999px; color: #c7d1d8; font-size: .78rem; line-height: 1; padding: .4rem .55rem; text-align: center; white-space: nowrap; }
+.detail-page { margin: 0 auto; max-width: 1040px; padding: 4.5rem 1.5rem 5rem; }
+.detail-page h1 { font-size: clamp(2.2rem, 5vw, 4.5rem); line-height: 1.05; max-width: 980px; }
+.detail-page h2 { margin-top: 3rem; }
+.detail-lede { color: var(--muted); font-size: 1.16rem; line-height: 1.7; max-width: 760px; }
+.detail-meta, .detail-actions { display: flex; flex-wrap: wrap; gap: .75rem; margin: 1.5rem 0; }
+.detail-meta span { background: #102b3a; border: 1px solid #315064; border-radius: 999px; color: #d4e4ec; font-size: .85rem; padding: .45rem .75rem; }
+.detail-actions { align-items: center; }
+.text-link { color: #9ee7d5; font-weight: 700; }
+.table-wrap { overflow-x: auto; border: 1px solid #315064; border-radius: 12px; }
+.table-wrap table { border-collapse: collapse; min-width: 700px; width: 100%; }
+.table-wrap th, .table-wrap td { border-bottom: 1px solid #254452; padding: .8rem; text-align: left; }
+.table-wrap th { background: #102b3a; color: #d4e4ec; }
+.table-wrap tr:last-child td { border-bottom: 0; }
+.detail-cta { background: #0e2d3d; border: 1px solid #315064; border-radius: 16px; margin-top: 3rem; padding: 1.5rem; }
+
 @media (max-width: 960px) {
   .hero { grid-template-columns: 1fr; padding: 4rem 0; }
   .signal-panel { max-width: 650px; }

index.html

@@ -69,7 +69,7 @@
         <div class="hero-copy">
           <p class="eyebrow">OPEN ENGINEERING REFERENCE</p>
           <h1>Find the registers.<br><span>Start polling sooner.</span></h1>
-          <p class="hero-lede">Search machine-readable Modbus map previews for meters, inverters, UPS systems, relays, and industrial equipment. Open the JSON or continue to the complete device guide.</p>
+          <p class="hero-lede">Search machine-readable Modbus map previews for meters, inverters, UPS systems, relays, and industrial equipment. Open the JSON, read an available device guide, or use the complete map in XPF.</p>
           <div class="hero-actions">
             <a class="button button-primary" href="#catalog">Browse public maps</a>
             <a class="button button-secondary" href="https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=site-hero">Use full maps in XPF</a>
@@ -81,8 +81,8 @@ <h1>Find the registers.<br><span>Start polling sooner.</span></h1>
             <span class="live-dot">PUBLIC</span>
           </div>
           <div class="metric-grid">
-            <div><strong id="mapMetric">101</strong><span>map previews</span></div>
-            <div><strong id="manufacturerMetric">21</strong><span>manufacturers</span></div>
+            <div><strong id="mapMetric">258</strong><span>map previews</span></div>
+            <div><strong id="manufacturerMetric">98</strong><span>manufacturers</span></div>
             <div><strong>JSON</strong><span>validated format</span></div>
             <div><strong>6–12</strong><span>signals per preview</span></div>
           </div>
@@ -98,7 +98,7 @@ <h1>Find the registers.<br><span>Start polling sooner.</span></h1>
         <span>✓ Human-readable names</span>
         <span>✓ Register addresses</span>
         <span>✓ Data types and units</span>
-        <span>✓ Canonical device guides</span>
+        <span>✓ Guide status shown clearly</span>
       </section>
 
       <section class="catalog-section" id="catalog">

maps/abb/a41-a42.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
-  "schema_version": "1.0.0",
+  "schema_version": "1.1.0",
   "id": "abb/a41-a42",
   "manufacturer": "ABB",
   "manufacturer_slug": "abb",
@@ -110,7 +110,9 @@
   "product": {
     "name": "Modbus Monitor XPF",
     "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/a41-a42",
-    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/a41-a42"
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/a41-a42",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
   },
-  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root.",
+  "guide_status": "published"
 }

maps/abb/b23-b24.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
-  "schema_version": "1.0.0",
+  "schema_version": "1.1.0",
   "id": "abb/b23-b24",
   "manufacturer": "ABB",
   "manufacturer_slug": "abb",
@@ -110,7 +110,9 @@
   "product": {
     "name": "Modbus Monitor XPF",
     "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/b23-b24",
-    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/b23-b24"
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/b23-b24",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
   },
-  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root.",
+  "guide_status": "published"
 }

maps/abb/m4m.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
-  "schema_version": "1.0.0",
+  "schema_version": "1.1.0",
   "id": "abb/m4m",
   "manufacturer": "ABB",
   "manufacturer_slug": "abb",
@@ -107,7 +107,9 @@
   "product": {
     "name": "Modbus Monitor XPF",
     "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/m4m",
-    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/m4m"
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/m4m",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
   },
-  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root.",
+  "guide_status": "published"
 }

maps/abb/trio-50-trio-60.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
-  "schema_version": "1.0.0",
+  "schema_version": "1.1.0",
   "id": "abb/trio-50-trio-60",
   "manufacturer": "ABB",
   "manufacturer_slug": "abb",
@@ -110,7 +110,9 @@
   "product": {
     "name": "Modbus Monitor XPF",
     "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/trio-50-trio-60",
-    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/trio-50-trio-60"
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=abb/trio-50-trio-60",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
   },
-  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root.",
+  "guide_status": "published"
 }

maps/accuenergy/acuvim-ii.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
-  "schema_version": "1.0.0",
+  "schema_version": "1.1.0",
   "id": "accuenergy/acuvim-ii",
   "manufacturer": "Accuenergy",
   "manufacturer_slug": "accuenergy",
@@ -110,7 +110,9 @@
   "product": {
     "name": "Modbus Monitor XPF",
     "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=accuenergy/acuvim-ii",
-    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=accuenergy/acuvim-ii"
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=accuenergy/acuvim-ii",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
   },
-  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root.",
+  "guide_status": "published"
 }

maps/acrel/acr10r.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "https://modbus-monitor.github.io/modbus-device-maps/schemas/modbus-map.schema.json",
+  "schema_version": "1.1.0",
+  "id": "acrel/acr10r",
+  "manufacturer": "Acrel",
+  "manufacturer_slug": "acrel",
+  "model": "ACR10R",
+  "slug": "acr10r",
+  "title": "Acrel ACR10R Modbus Register Map",
+  "description": "Official Modbus Monitor XPF preview for the Acrel ACR10R power meter, with 12 representative voltage, current, power signals.",
+  "device_type": "Power Meter",
+  "protocol": "Modbus RTU / Modbus TCP",
+  "categories": [
+    "Voltage",
+    "Current",
+    "Power",
+    "Energy",
+    "Frequency",
+    "Demand"
+  ],
+  "address_display_convention": "Display address copied from the official XPF map preview. Modbus reference-number and zero-based offset conventions vary by device; verify the manufacturer manual before polling or writing.",
+  "registers": [
+    {
+      "name": "Secondary side rated voltage ue V",
+      "display_address": "400004",
+      "data_type": "UINT16",
+      "unit": "V",
+      "category": "Voltage"
+    },
+    {
+      "name": "Secondary side rated current value ie A",
+      "display_address": "400005",
+      "data_type": "UINT16",
+      "unit": "-",
+      "category": "Current"
+    },
+    {
+      "name": "Power primary and secondary side coefficients",
+      "display_address": "400018",
+      "data_type": "UINT32",
+      "unit": "kW",
+      "category": "Power"
+    },
+    {
+      "name": "This month active peak electric energy kWh",
+      "display_address": "400333",
+      "data_type": "UINT32",
+      "unit": "kWh",
+      "category": "Energy"
+    },
+    {
+      "name": "Frequency F",
+      "display_address": "400252",
+      "data_type": "UINT16",
+      "unit": "Hz",
+      "category": "Frequency"
+    },
+    {
+      "name": "Maximum demand",
+      "display_address": "400301",
+      "data_type": "UINT32",
+      "unit": "kW",
+      "category": "Demand"
+    },
+    {
+      "name": "DIDO state",
+      "display_address": "401000",
+      "data_type": "UINT16",
+      "unit": "-",
+      "category": "Status"
+    },
+    {
+      "name": "Communication speed bps",
+      "display_address": "400001",
+      "data_type": "UINT16",
+      "unit": "-",
+      "category": "Communication"
+    },
+    {
+      "name": "Wiring mode wire",
+      "display_address": "400003",
+      "data_type": "UINT16",
+      "unit": "-",
+      "category": "General"
+    },
+    {
+      "name": "Primary side rated voltage PU kV",
+      "display_address": "400006",
+      "data_type": "UINT16",
+      "unit": "V",
+      "category": "Voltage"
+    },
+    {
+      "name": "Voltage primary side and",
+      "display_address": "400014",
+      "data_type": "UINT32",
+      "unit": "V",
+      "category": "Voltage"
+    },
+    {
+      "name": "Primary side and secondary side coefficient of current",
+      "display_address": "400016",
+      "data_type": "UINT32",
+      "unit": "-",
+      "category": "Current"
+    }
+  ],
+  "register_count": 12,
+  "guide_status": "upcoming",
+  "documentation_url": null,
+  "product": {
+    "name": "Modbus Monitor XPF",
+    "full_map_url": "https://www.modbusmonitor.com/download?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=acrel/acr10r",
+    "tester_url": "https://www.modbusmonitor.com/modbus-tester?utm_source=github&utm_medium=referral&utm_campaign=device_maps&utm_content=acrel/acr10r",
+    "request_url": "https://github.com/Modbus-Monitor/modbus-device-maps/issues/new/choose"
+  },
+  "license_notice": "See DATA_LICENSE.md and DISCLAIMER.md in the repository root."
+}