This commit is contained in:
parent
4e6901d13a
commit
82a28e3eed
@ -1,7 +1,7 @@
|
|||||||
asyncapi: 2.0.0
|
asyncapi: 2.0.0
|
||||||
info:
|
info:
|
||||||
title: Birbnetes API
|
title: Birbnetes API
|
||||||
version: '2.0.0'
|
version: '2.0.1'
|
||||||
description: |
|
description: |
|
||||||
Async messages sent between major components of the Birbnetes system.
|
Async messages sent between major components of the Birbnetes system.
|
||||||
contact:
|
contact:
|
||||||
@ -105,7 +105,7 @@ channels:
|
|||||||
operationId: sendprobability
|
operationId: sendprobability
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/output'
|
$ref: '#/components/messages/output'
|
||||||
device/sensor:
|
device/sensor/{deviceID}/{sensorID}:
|
||||||
bindings:
|
bindings:
|
||||||
mqt:
|
mqt:
|
||||||
qos: 1
|
qos: 1
|
||||||
@ -124,7 +124,7 @@ channels:
|
|||||||
operationId: sendSensorData
|
operationId: sendSensorData
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/sensor'
|
$ref: '#/components/messages/sensor'
|
||||||
device/control:
|
device/control/{deviceID}:
|
||||||
bindings:
|
bindings:
|
||||||
mqt:
|
mqt:
|
||||||
qos: 2
|
qos: 2
|
||||||
@ -132,18 +132,37 @@ channels:
|
|||||||
bindingVersion: 0.1.0
|
bindingVersion: 0.1.0
|
||||||
description: Command messages sent by the cloud
|
description: Command messages sent by the cloud
|
||||||
subscribe:
|
subscribe:
|
||||||
summary: Recieve control messages
|
summary: Recieve control messages of device
|
||||||
description: Shutdown and powerof messages sent by cloud
|
description: Shutdown and powerof messages sent by cloud to a particular device
|
||||||
operationId: recieveCommand
|
operationId: recieveDeviceCommand
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/controlmessage'
|
$ref: '#/components/messages/controlmessage'
|
||||||
publish:
|
publish:
|
||||||
summary: Send control messages
|
summary: Send control messages to device
|
||||||
description: Send shutdown and poweron commands to a device or sensor.
|
description: Send shutdown and poweron commands to a device.
|
||||||
operationId: sendCommand
|
operationId: sendDeviceCommand
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/controlmessage'
|
$ref: '#/components/messages/controlmessage'
|
||||||
device/status:
|
device/control/{deviceID}/{sensorID}:
|
||||||
|
bindings:
|
||||||
|
mqt:
|
||||||
|
qos: 2
|
||||||
|
retain: true
|
||||||
|
bindingVersion: 0.1.0
|
||||||
|
description: Command messages sent by the cloud
|
||||||
|
subscribe:
|
||||||
|
summary: Recieve control messages of sensor
|
||||||
|
description: Shutdown and powerof messages sent by cloud to a sensor
|
||||||
|
operationId: recieveSensorCommand
|
||||||
|
message:
|
||||||
|
$ref: '#/components/messages/controlmessage'
|
||||||
|
publish:
|
||||||
|
summary: Send control messages to sensor
|
||||||
|
description: Send shutdown and poweron commands to a sensor.
|
||||||
|
operationId: sendSensorCommand
|
||||||
|
message:
|
||||||
|
$ref: '#/components/messages/controlmessage'
|
||||||
|
device/status/{deviceID}:
|
||||||
bindings:
|
bindings:
|
||||||
mqt:
|
mqt:
|
||||||
qos: 0
|
qos: 0
|
||||||
@ -151,18 +170,36 @@ channels:
|
|||||||
bindingVersion: 0.1.0
|
bindingVersion: 0.1.0
|
||||||
description: Status messages of a device
|
description: Status messages of a device
|
||||||
subscribe:
|
subscribe:
|
||||||
summary: Recieve device status messages
|
summary: Recieve device status messages of device
|
||||||
description: Operation faliure or device status information
|
description: Operation faliure or device status information
|
||||||
operationId: recieveStatusMessage
|
operationId: recieveStatusMessage
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/statusmessage'
|
$ref: '#/components/messages/statusmessage'
|
||||||
publish:
|
publish:
|
||||||
summary: Send status messages
|
summary: Send status messages of device
|
||||||
description: Send operational messages to interested parties
|
description: Send operational messages of a device to interested parties
|
||||||
|
operationId: sendStatusMessage
|
||||||
|
message:
|
||||||
|
$ref: '#/components/messages/statusmessage'
|
||||||
|
device/status/{deviceID}/{sensorID}:
|
||||||
|
bindings:
|
||||||
|
mqt:
|
||||||
|
qos: 0
|
||||||
|
retain: true
|
||||||
|
bindingVersion: 0.1.0
|
||||||
|
description: Status messages of a device
|
||||||
|
subscribe:
|
||||||
|
summary: Recieve device status messages of sensor
|
||||||
|
description: Operation faliure or sensor status information
|
||||||
|
operationId: recieveStatusMessage
|
||||||
|
message:
|
||||||
|
$ref: '#/components/messages/statusmessage'
|
||||||
|
publish:
|
||||||
|
summary: Send status messages of sensor
|
||||||
|
description: Send operational messages of a sensor to interested parties
|
||||||
operationId: sendStatusMessage
|
operationId: sendStatusMessage
|
||||||
message:
|
message:
|
||||||
$ref: '#/components/messages/statusmessage'
|
$ref: '#/components/messages/statusmessage'
|
||||||
|
|
||||||
components:
|
components:
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
user_pass:
|
user_pass:
|
||||||
@ -242,41 +279,17 @@ components:
|
|||||||
samplePayload:
|
samplePayload:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
deviceID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular device in the system.
|
|
||||||
sensorID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular sensor on a device.
|
|
||||||
measurement:
|
measurement:
|
||||||
type: string
|
type: string
|
||||||
summary: Measurement data
|
summary: Measurement data
|
||||||
controlPayload:
|
controlPayload:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
deviceID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular device in the system.
|
|
||||||
sensorID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular sensor on a device. (May be wildcard or empty)
|
|
||||||
command:
|
command:
|
||||||
type: string
|
type: string
|
||||||
enum: ["online", "offline", "doAlert"]
|
enum: ["online", "offline", "doAlert"]
|
||||||
statusPayload:
|
statusPayload:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
deviceID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular device in the system.
|
|
||||||
sensorID:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
summary: Unique ID used to identify a particular sensor on a device. (May be wildcard or empty)
|
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
Loading…
Reference in New Issue
Block a user