@portpowered/reference-data 0.4.1 → 0.4.3

package/generated/public/docs/references/schemas/SimulatorSharedFields.json

@@ -0,0 +1,106 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Shared simulator fields. Existing device_type wire spelling is retained for compatibility in both media projections.",
+  "allOf": [
+    {
+      "type": "object",
+      "required": [
+        "device_type"
+      ],
+      "properties": {
+        "device_type": {
+          "type": "string",
+          "description": "The type of device being simulated",
+          "enum": [
+            "LIGHT",
+            "LOCK",
+            "SENSOR",
+            "THERMOSTAT",
+            "TV",
+            "CAMERA",
+            "VACUUM",
+            "COLORED_LIGHT",
+            "SWITCH",
+            "PLUG",
+            "FAN",
+            "CLOSURE",
+            "WINDOW_COVERING",
+            "CONTACT_SENSOR",
+            "HUMIDITY_SENSOR",
+            "LIGHT_SENSOR",
+            "STANDALONE_TEMPERATURE_SENSOR",
+            "AIR_QUALITY_SENSOR",
+            "CO_SENSOR",
+            "COOKTOP",
+            "DISHWASHER",
+            "MICROWAVE_OVEN",
+            "OVEN",
+            "REFRIGERATOR",
+            "EXTRACTOR_HOOD",
+            "LAUNDRY_WASHER",
+            "LAUNDRY_DRYER",
+            "AUDIO_PLAYER",
+            "MEDIA_PLAYER",
+            "MEDIA_PROVIDER",
+            "SPEAKER",
+            "TEXT_MESSAGE_RECEIVER",
+            "CALENDAR_PROVIDER",
+            "KEYPAD",
+            "LOCATION_TRACKER",
+            "SMOKE_ALARM",
+            "SECURITY_PANEL",
+            "PET_FEEDER"
+          ],
+          "x-enum-varnames": [
+            "Light",
+            "Lock",
+            "Sensor",
+            "Thermostat",
+            "Tv",
+            "Camera",
+            "Vacuum",
+            "ColoredLight",
+            "Switch",
+            "Plug",
+            "Fan",
+            "Closure",
+            "WindowCovering",
+            "ContactSensor",
+            "HumiditySensor",
+            "LightSensor",
+            "StandaloneTemperatureSensor",
+            "AirQualitySensor",
+            "CoSensor",
+            "Cooktop",
+            "Dishwasher",
+            "MicrowaveOven",
+            "Oven",
+            "Refrigerator",
+            "ExtractorHood",
+            "LaundryWasher",
+            "LaundryDryer",
+            "AudioPlayer",
+            "MediaPlayer",
+            "MediaProvider",
+            "Speaker",
+            "TextMessageReceiver",
+            "CalendarProvider",
+            "Keypad",
+            "LocationTracker",
+            "SmokeAlarm",
+            "SecurityPanel",
+            "PetFeeder"
+          ]
+        },
+        "state": {
+          "type": "object",
+          "additionalProperties": true,
+          "description": "Initial or replacement simulated device state. Omit to preserve state on update; an empty object resets observations. Fixture state does not control physical devices."
+        },
+        "configuration": {
+          "$ref": "/docs/references/schemas/SimulatorConfiguration.json"
+        }
+      }
+    }
+  ]
+}

package/generated/public/docs/references/schemas/SimulatorV2.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Vendor v2 name-value projection.",
+  "allOf": [
+    {
+      "$ref": "/docs/references/schemas/SimulatorRecordFields.json"
+    },
+    {
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "$ref": "/docs/references/schemas/TypeValue.json"
+        }
+      }
+    }
+  ]
+}

package/generated/public/docs/references/schemas/SleepNodeConfiguration.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/flow-nodes/sleep",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "required": [
+    "duration"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "duration": {
+      "type": "string",
+      "description": "The duration to sleep for, representated as ISO8601",
+      "example": "PT10S"
+    }
+  }
+}

package/generated/public/docs/references/schemas/SmokeCoAlarmInterfaceAlarmStateAttribute.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/smoke-co-alarm",
+  "x-name": "alarm-state",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "$ref": "/docs/references/schemas/AlarmState.json"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SmokeCoAlarmInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/smoke-co-alarm",
+  "x-name": "smoke-co-alarm",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SnapshotInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/snapshot",
+  "x-name": "snapshot",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SnapshotInterfaceGetSnapshotMessage.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/snapshot",
+  "x-name": "get-snapshot",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "preferOnDemandSnapshot": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SnapshotInterfaceGetSnapshotResponseMessage.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/snapshot",
+  "x-name": "get-snapshot-response",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "type": "object",
+  "required": [
+    "value",
+    "timeOfSample"
+  ],
+  "properties": {
+    "value": {
+      "$ref": "/docs/references/schemas/SnapshotValue.json"
+    },
+    "timeOfSample": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SnapshotValue.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "A snapshot value with URI and expiration",
+  "properties": {
+    "uri": {
+      "type": "string"
+    },
+    "expirationTime": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}

package/generated/public/docs/references/schemas/SoilMoistureSensorInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/soil-moisture-sensor",
+  "x-name": "soil-moisture-sensor",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SoilMoistureSensorInterfaceMeasuredValueAttribute.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/soil-moisture-sensor",
+  "x-name": "measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "$ref": "/docs/references/schemas/MeasurementValue.json"
+    },
+    "unit": {
+      "$ref": "/docs/references/schemas/MeasurementUnit.json"
+    }
+  },
+  "required": [
+    "value",
+    "unit"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialAxisDirection.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Direction in which an axis increases, relative to the provider's map as presented to the user",
+  "enum": [
+    "RIGHT",
+    "LEFT",
+    "UP",
+    "DOWN"
+  ],
+  "x-enum-varnames": [
+    "SpatialAxisDirectionRight",
+    "SpatialAxisDirectionLeft",
+    "SpatialAxisDirectionUp",
+    "SpatialAxisDirectionDown"
+  ]
+}

package/generated/public/docs/references/schemas/SpatialCoordinate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "array",
+  "description": "A position as [x, y] or [x, y, z] in the frame's coordinate system",
+  "minItems": 2,
+  "maxItems": 3,
+  "items": {
+    "type": "number"
+  }
+}

package/generated/public/docs/references/schemas/SpatialCoordinateSystem.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Coordinate system of a provider frame. Declared only where the provider's units and axes are proven.",
+  "required": [
+    "unit",
+    "dimensions",
+    "xAxis",
+    "yAxis"
+  ],
+  "properties": {
+    "unit": {
+      "type": "string",
+      "enum": [
+        "METER"
+      ],
+      "description": "Length unit of coordinates in this frame"
+    },
+    "dimensions": {
+      "type": "integer",
+      "minimum": 2,
+      "maximum": 3,
+      "description": "Number of coordinate dimensions"
+    },
+    "xAxis": {
+      "$ref": "/docs/references/schemas/SpatialAxisDirection.json"
+    },
+    "yAxis": {
+      "$ref": "/docs/references/schemas/SpatialAxisDirection.json"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialInterfaceActiveAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/spatial",
+  "x-name": "active",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "description": "Whether this map or floor is the provider's currently loaded map (maps only)",
+  "type": "object",
+  "required": [
+    "value"
+  ],
+  "properties": {
+    "value": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialInterfaceConfiguration.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/spatial",
+  "x-name": "spatial",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "description": "Descriptive spatial declaration of a group route (home, floor/map, room or zone). The spatial interface declares no control messages; cleaning is sent to the robot endpoint.",
+  "type": "object",
+  "required": [
+    "role"
+  ],
+  "properties": {
+    "role": {
+      "$ref": "/docs/references/schemas/SpatialRole.json"
+    },
+    "coordinateSystem": {
+      "$ref": "/docs/references/schemas/SpatialCoordinateSystem.json"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialInterfaceGeometryAttribute.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/spatial",
+  "x-name": "geometry",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "description": "Observed area of the group route in the coordinate system of its reference frame",
+  "type": "object",
+  "required": [
+    "shape",
+    "observedAt"
+  ],
+  "properties": {
+    "shape": {
+      "$ref": "/docs/references/schemas/SpatialShape.json"
+    },
+    "relativeToGroupId": {
+      "type": "string",
+      "description": "Canonical endpoint group whose frame the coordinates use"
+    },
+    "relativeToGroupRouteId": {
+      "type": "string",
+      "description": "Provider group route whose coordinate system the coordinates use"
+    },
+    "observedAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the provider observed this geometry"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialInterfacePositionAttribute.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/spatial",
+  "x-name": "position",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "description": "Anchor point of the group route in its reference frame. It is a label anchor, not a navigation target.",
+  "type": "object",
+  "required": [
+    "point",
+    "observedAt"
+  ],
+  "properties": {
+    "point": {
+      "$ref": "/docs/references/schemas/SpatialPoint.json"
+    },
+    "relativeToGroupId": {
+      "type": "string",
+      "description": "Canonical endpoint group whose frame the coordinates use"
+    },
+    "relativeToGroupRouteId": {
+      "type": "string",
+      "description": "Provider group route whose coordinate system the coordinates use"
+    },
+    "observedAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the provider observed this position"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialLinearRing.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "array",
+  "description": "A closed ring of positions; the first and last positions are equal (GeoJSON linear ring)",
+  "minItems": 4,
+  "items": {
+    "$ref": "/docs/references/schemas/SpatialCoordinate.json"
+  }
+}

package/generated/public/docs/references/schemas/SpatialMultiPolygon.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "GeoJSON-like multi-polygon: a list of polygons, each a list of rings",
+  "required": [
+    "type",
+    "coordinates"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "x-enum-exempt": "GeoJSON geometry type (RFC 7946)",
+      "enum": [
+        "MultiPolygon"
+      ]
+    },
+    "coordinates": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "array",
+        "minItems": 1,
+        "items": {
+          "$ref": "/docs/references/schemas/SpatialLinearRing.json"
+        }
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialPoint.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "GeoJSON-like point",
+  "required": [
+    "type",
+    "coordinates"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "x-enum-exempt": "GeoJSON geometry type (RFC 7946)",
+      "enum": [
+        "Point"
+      ]
+    },
+    "coordinates": {
+      "$ref": "/docs/references/schemas/SpatialCoordinate.json"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialPolygon.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "GeoJSON-like polygon: an exterior ring followed by optional interior rings (holes)",
+  "required": [
+    "type",
+    "coordinates"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "x-enum-exempt": "GeoJSON geometry type (RFC 7946)",
+      "enum": [
+        "Polygon"
+      ]
+    },
+    "coordinates": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "/docs/references/schemas/SpatialLinearRing.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpatialRole.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Spatial role of a group route: a whole home, a floor or map, a room, or a zone within a room",
+  "enum": [
+    "HOME",
+    "FLOOR",
+    "ROOM",
+    "ZONE"
+  ],
+  "x-enum-varnames": [
+    "SpatialRoleHome",
+    "SpatialRoleFloor",
+    "SpatialRoleRoom",
+    "SpatialRoleZone"
+  ]
+}

package/generated/public/docs/references/schemas/SpatialShape.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Area covered by a group route, as a polygon or multi-polygon",
+  "oneOf": [
+    {
+      "$ref": "/docs/references/schemas/SpatialPolygon.json"
+    },
+    {
+      "$ref": "/docs/references/schemas/SpatialMultiPolygon.json"
+    }
+  ],
+  "discriminator": {
+    "propertyName": "type",
+    "mapping": {
+      "Polygon": "/docs/references/schemas/SpatialPolygon.json",
+      "MultiPolygon": "/docs/references/schemas/SpatialMultiPolygon.json"
+    }
+  }
+}

package/generated/public/docs/references/schemas/SpeakerInterfaceAdjustVolumeMessage.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/speaker",
+  "x-name": "adjust-volume",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "required": [
+    "volumeDelta"
+  ],
+  "properties": {
+    "volumeDelta": {
+      "type": "number"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpeakerInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/speaker",
+  "x-name": "speaker",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpeakerInterfaceMutedAttribute.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/speaker",
+  "x-name": "muted",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SpeakerInterfaceSetMuteMessage.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/speaker",
+  "x-name": "set-mute",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "required": [
+    "mute"
+  ],
+  "properties": {
+    "mute": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}