@portpowered/reference-data 0.4.1 → 0.4.3

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

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/motion-sensor",
+  "x-name": "detection-state",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "DETECTED",
+        "NOT_DETECTED"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/motion-sensor",
+  "x-name": "motion-detected",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "x-event": true,
+  "x-event-name": "camera.motion_detected",
+  "description": "A distinct motion occurrence, independent of cached detection state.",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "DETECTED"
+      ],
+      "x-enum-varnames": [
+        "MotionSensorOccurrenceDetected"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "A movement instruction for remote control",
+  "properties": {
+    "velocity": {
+      "type": "number",
+      "description": "Forward/backward speed"
+    },
+    "omega": {
+      "type": "number",
+      "description": "Angular velocity for turning"
+    },
+    "duration": {
+      "type": "integer",
+      "description": "Duration in milliseconds"
+    }
+  },
+  "required": [
+    "velocity",
+    "omega",
+    "duration"
+  ],
+  "additionalProperties": false
+}

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

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

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

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/nitrogen-dioxide-concentration-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/NotificationCapabilityInterfaceConfiguration.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "/docs/references/schemas/configuration-7.json"
+}

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Conditions for triggering a notification",
+  "properties": {
+    "eventType": {
+      "type": "string",
+      "description": "Type of event that triggers the notification"
+    },
+    "eventData": {
+      "type": "object",
+      "description": "Data that must match for the event to trigger"
+    },
+    "timeWindow": {
+      "$ref": "/docs/references/schemas/NotificationTimeWindow.json"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/notification",
+  "x-name": "notification",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "type": "object",
+  "properties": {
+    "notificationId": {
+      "type": "string",
+      "description": "Unique identifier for this notification",
+      "minLength": 1
+    },
+    "title": {
+      "type": "string",
+      "description": "Notification title",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "body": {
+      "type": "string",
+      "description": "Notification body text",
+      "minLength": 1,
+      "maxLength": 2000
+    },
+    "priority": {
+      "type": "string",
+      "description": "Notification priority level",
+      "enum": [
+        "LOW",
+        "NORMAL",
+        "HIGH",
+        "URGENT"
+      ],
+      "x-enum-varnames": [
+        "NotificationInterfaceNotificationMessagePriorityLow",
+        "NotificationInterfaceNotificationMessagePriorityNormal",
+        "NotificationInterfaceNotificationMessagePriorityHigh",
+        "NotificationInterfaceNotificationMessagePriorityUrgent"
+      ]
+    },
+    "channels": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "PUSH",
+          "EMAIL",
+          "SMS",
+          "IN_APP",
+          "WEBHOOK"
+        ],
+        "x-enum-varnames": [
+          "NotificationInterfaceNotificationMessageChannelsPush",
+          "NotificationInterfaceNotificationMessageChannelsEmail",
+          "NotificationInterfaceNotificationMessageChannelsSms",
+          "NotificationInterfaceNotificationMessageChannelsInApp",
+          "NotificationInterfaceNotificationMessageChannelsWebhook"
+        ]
+      },
+      "description": "Channels to send the notification through"
+    },
+    "targetUsers": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "List of user IDs to send the notification to"
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Additional metadata for the notification",
+      "additionalProperties": true
+    }
+  },
+  "required": [
+    "title",
+    "body"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/notification",
+  "x-name": "notification-schedule",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "scheduleId": {
+      "type": "string",
+      "description": "Unique identifier for this schedule",
+      "minLength": 1
+    },
+    "notification": {
+      "$ref": "/docs/references/schemas/NotificationPayload.json"
+    },
+    "schedule": {
+      "$ref": "/docs/references/schemas/NotificationSchedule.json"
+    },
+    "enabled": {
+      "type": "boolean",
+      "description": "Whether the schedule is enabled",
+      "default": true
+    }
+  },
+  "required": [
+    "scheduleId",
+    "notification",
+    "schedule"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/notification",
+  "x-name": "notification-trigger",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "triggerId": {
+      "type": "string",
+      "description": "Unique identifier for this trigger",
+      "minLength": 1
+    },
+    "triggerType": {
+      "type": "string",
+      "description": "Type of trigger",
+      "enum": [
+        "IMMEDIATE",
+        "SCHEDULED",
+        "EVENT_BASED",
+        "CONDITION_BASED"
+      ],
+      "x-enum-varnames": [
+        "Immediate",
+        "Scheduled",
+        "EventBased",
+        "ConditionBased"
+      ]
+    },
+    "notification": {
+      "$ref": "/docs/references/schemas/NotificationPayload.json"
+    },
+    "conditions": {
+      "$ref": "/docs/references/schemas/NotificationConditions.json"
+    },
+    "schedule": {
+      "$ref": "/docs/references/schemas/NotificationSchedule.json"
+    }
+  },
+  "required": [
+    "triggerId",
+    "triggerType",
+    "notification"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Interval between notifications",
+  "properties": {
+    "value": {
+      "type": "integer",
+      "description": "Interval value",
+      "minimum": 1
+    },
+    "unit": {
+      "type": "string",
+      "description": "Interval unit",
+      "enum": [
+        "SECONDS",
+        "MINUTES",
+        "HOURS",
+        "DAYS",
+        "WEEKS",
+        "MONTHS"
+      ],
+      "x-enum-varnames": [
+        "Seconds",
+        "Minutes",
+        "Hours",
+        "Days",
+        "Weeks",
+        "Months"
+      ]
+    }
+  },
+  "required": [
+    "value",
+    "unit"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Notification payload information",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Notification title",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "body": {
+      "type": "string",
+      "description": "Notification body text",
+      "minLength": 1,
+      "maxLength": 2000
+    },
+    "priority": {
+      "type": "string",
+      "description": "Notification priority level",
+      "enum": [
+        "LOW",
+        "NORMAL",
+        "HIGH",
+        "URGENT"
+      ],
+      "x-enum-varnames": [
+        "NotificationPayloadPriorityLow",
+        "NotificationPayloadPriorityNormal",
+        "NotificationPayloadPriorityHigh",
+        "NotificationPayloadPriorityUrgent"
+      ]
+    },
+    "channels": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "PUSH",
+          "EMAIL",
+          "SMS",
+          "IN_APP",
+          "WEBHOOK"
+        ],
+        "x-enum-varnames": [
+          "NotificationPayloadChannelsPush",
+          "NotificationPayloadChannelsEmail",
+          "NotificationPayloadChannelsSms",
+          "NotificationPayloadChannelsInApp",
+          "NotificationPayloadChannelsWebhook"
+        ]
+      },
+      "description": "Channels to send the notification through"
+    },
+    "targetUsers": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "List of user IDs to send the notification to"
+    }
+  },
+  "required": [
+    "title",
+    "body",
+    "priority",
+    "channels",
+    "targetUsers"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Schedule configuration for notifications",
+  "properties": {
+    "startTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When to start sending notifications"
+    },
+    "endTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When to stop sending notifications (optional)"
+    },
+    "cronExpression": {
+      "type": "string",
+      "description": "Cron expression for recurring notifications"
+    },
+    "timezone": {
+      "type": "string",
+      "description": "Timezone for the schedule",
+      "default": "UTC"
+    },
+    "repeatCount": {
+      "type": "integer",
+      "description": "Number of times to repeat (null for infinite)",
+      "minimum": 1
+    },
+    "interval": {
+      "$ref": "/docs/references/schemas/NotificationInterval.json"
+    }
+  },
+  "required": [
+    "startTime"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Time window for a notification trigger",
+  "properties": {
+    "startTime": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "endTime": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "additionalProperties": false
+}

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

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

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

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/ozone-concentration-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/OAuth2ConnectionData.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "clientId",
+    "clientSecret",
+    "redirectUri"
+  ],
+  "properties": {
+    "clientId": {
+      "type": "string",
+      "description": "The OAuth2 client ID"
+    },
+    "clientSecret": {
+      "type": "string",
+      "description": "The OAuth2 client secret"
+    },
+    "redirectUri": {
+      "type": "string",
+      "description": "The OAuth2 redirect URI"
+    },
+    "tokenUrl": {
+      "type": "string",
+      "description": "The OAuth2 token endpoint URL used for token exchange and refresh"
+    }
+  }
+}