ledwall/protocol.yml at main · magicmonkey/ledwall · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
asyncapi: '2.0.0'
info:
  title: LED wall
  version: 0.0.1
  description: This controls the LED wall

servers:
  mosquitto:
    url: 10.1.0.1:1339
    description: Mosquitto broker
    protocol: MQTT

channels:
  /ledwall/1/request:
    publish:
      operationId: ledwall
      message:
        oneOf:
          - $ref: '#/components/messages/firework'
          - $ref: '#/components/messages/fireworkTick'
          - $ref: '#/components/messages/background'
          - $ref: '#/components/messages/pixel'
          - $ref: '#/components/messages/clearpixels'
          - $ref: '#/components/messages/brightness'
          - $ref: '#/components/messages/snake'
          - $ref: '#/components/messages/pulse'
          - $ref: '#/components/messages/ping'
          - $ref: '#/components/messages/reset'

  /ledwall/1/response:
    subscribe:
      operationId: ledwallack
      message:
        $ref: "#/components/messages/response"

components:
  messages:

    firework:
      description: Launch a firework
      payload:
        type: object
        properties:
          action:
            type: string
            const: "firework"
          hue:
            type: integer
            description: Numerical hue, 0-65535
            minimum: 0
            maximum: 65535
        required: ["action"]

    fireworkTick:
      description: Change the time between regular fireworks
      payload:
        type: object
        properties:
          action:
            type: string
            const: "fireworkTick"
          time:
            type: integer
            description: Time, in milliseconds
            minimum: 0
            maximum: 100000
        required: ["action", "time"]

    background:
      description: Set a background colour for the whole LED wall
      payload:
        type: object
        properties:
          action:
            type: string
            const: "background"
          r:
            type: integer
            description: Amount of red
            minimum: 0
            maximum: 50
          g:
            type: integer
            description: Amount of green
            minimum: 0
            maximum: 50
          b:
            type: integer
            description: Amount of blue
            minimum: 0
            maximum: 50
        required: ["action", "r", "g", "b"]

    pixel:
      description: Set an individual pixel to a given colour
      payload:
        type: object
        properties:
          action:
            type: string
            const: "pixel"
          num:
            type: integer
            description: Pixel number
            minimum: 0
            maximum: 237
          r:
            type: integer
            description: Amount of red
            minimum: 0
            maximum: 50
          g:
            type: integer
            description: Amount of green
            minimum: 0
            maximum: 50
          b:
            type: integer
            description: Amount of blue
            minimum: 0
            maximum: 50
        required: ["action", "num", "r", "g", "b"]

    clearpixels:
      description: Clear all of the individually-set pixels
      payload:
        type: object
        properties:
          action:
            type: string
            const: "clearpixels"
        required: ["action"]

    brightness:
      description: Set the brightness for the next firework or snake
      payload:
        type: object
        properties:
          action:
            type: string
            const: "brightness"
          amount:
            type: integer
            description: Brightness amount
            minimum: 0
            maximum: 255
        required: ["action", "amount"]

    snake:
      description: Turn the snake on or off
      payload:
        type: object
        properties:
          action:
            type: string
            const: "snake"
          enabled:
            type: boolean
        required: ["action", "enabled"]

    pulse:
      description: Send a "pulse" out of all edges from a given node
      payload:
        type: object
        properties:
          action:
            type: string
            const: "pulse"
          hue:
            type: integer
            description: Numerical hue, 0-65535
            minimum: 0
            maximum: 65535
          node:
            type: integer
            description: Node number
            minimum: 0
            maximum: 11
        required: ["action", "hue", "node"]

    ping:
      description: Ping the chip and expect a response
      payload:
        type: object
        properties:
          action:
            type: string
            const: "ping"
        required: ["action"]

    reset:
      description: Software reboot the chip
      payload:
        type: object
        properties:
          action:
            type: string
            const: "reset"
        required: ["action"]

    response:
      description: Diagnostic and other feedback from the wall
      payload:
        type: object
        properties:
          message:
            type: string
        required: ["message"]