model.json validation (#82)

Author: bramstroker

.github/workflows/model-json-validate.yml

@@ -0,0 +1,21 @@
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '**/model.json'
+name: Validate model.json files
+jobs:
+  validate_model_json:
+    name: Validate files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Validate model.json against schema
+        uses: snapcart/[email protected]
+        with:
+          token: ${{ secrets.GH_API_TOKEN }}
+          json_schema: ./custom_components/powercalc/data/model_schema.json
+          json_path_pattern: .*model.json$
+          send_comment: true
+          clear_comments: true

custom_components/powercalc/data/model_schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "model.json described a light model",
+  "type": "object",
+  "required": [
+    "name",
+    "standby_usage",
+    "supported_modes",
+    "measure_method",
+    "measure_device"
+  ],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The full name"
+    },
+    "standby_usage": {
+      "type": "number",
+      "description": "Power draw when the light is turned of. When you are not able to measure set to 0.4"
+    },
+    "supported_modes": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["lut", "linear", "fixed"]
+      },
+      "description": "Supported calculation modes"
+    },
+    "measure_method": {
+      "type": "string",
+      "enum": ["manual", "script"],
+      "description": "How the light was measured"
+    },
+    "measure_device": {
+      "type": "string",
+      "description": "Device which was used to measure"
+    },
+    "measure_description": {
+      "type": "string",
+      "description": "Add more information about how you measured the light or any remarks"
+    },
+    "linear_config": {
+      "type": "object",
+      "description": "Configuration for linear calculation mode",
+      "properties": {
+        "min_watt": {
+          "type": "number"
+        },
+        "max_watt": {
+          "type": "number"
+        }
+      }
+    },
+    "fixed_config": {
+      "type": "object",
+      "description": "Configuration for fixed calculation mode",
+      "properties": {
+        "watt": {
+          "type": "number"
+        }
+      }
+    }
+  }
+}