btclock/webui
3
0
Fork 2
Code Issues 1 Pull requests 11 Projects Releases 45 Packages Wiki Activity Actions

Added individual LED control

Browse source
This commit is contained in:
Djuri 2023-11-18 13:55:55 +01:00
parent 58fa1e7ecb
commit d3c6e52f3f
8 changed files with 237 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

109
static/swagger.json
View file

@ -7,7 +7,7 @@
},
"servers": [
{
"url": "/api/"
"url": "http://192.168.20.231/api/"
}
],
"paths": {
@ -216,7 +216,37 @@
"summary": "Get LEDs status",
"responses": {
"200": {
"description": "successful operation"
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArrayOfLeds"
}
}
}
}
}
},
"patch": {
"tags": [
"lights"
],
"summary": "Set individual LEDs",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArrayOfLedsInput"
}
}
}
},
"responses": {
"200": {
"description": "succesful operation"
},
"400": {
"description": "invalid colors or wrong amount of LEDs"
}
}
}
@ -275,24 +305,69 @@
},
"components": {
"schemas": {
"RgbColorValues": {
"type": "object",
"properties": {
"red": {
"type": "integer",
"minimum": 0,
"maximum": 255,
"example": 255
},
"green": {
"type": "integer",
"minimum": 0,
"maximum": 255,
"example": 204
},
"blue": {
"type": "integer",
"minimum": 0,
"maximum": 255,
"example": 0
}
}
},
"RgbColorHex": {
"type": "object",
"properties": {
"hex": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$",
"example": "#FFCC00"
}
}
},
"RgbColorValueAndHex": {
"allOf": [
{
"$ref": "#/components/schemas/RgbColorValues"
},
{
"$ref": "#/components/schemas/RgbColorHex"
}
]
},
"RgbColorValueOrHex": {
"oneOf": [
{
"$ref": "#/components/schemas/RgbColorValues"
},
{
"$ref": "#/components/schemas/RgbColorHex"
}
]
},
"ArrayOfLeds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"red": {
"type": "integer"
},
"green": {
"type": "integer"
},
"blue": {
"type": "integer"
},
"hex": {
"type": "string"
}
}
"$ref": "#/components/schemas/RgbColorValueAndHex"
}
},
"ArrayOfLedsInput": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RgbColorValueOrHex"
}
},
"Settings": {

54
static/swagger.yaml → static/swagger.yml
View file

@ -4,7 +4,7 @@ info:
version: '3.0'
description: BTClock V3 API
servers:
- url: /api/
- url: http://192.168.20.231/api/
paths:
/status:
get:
@ -135,6 +135,24 @@ paths:
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfLeds'
patch:
tags:
- lights
summary: Set individual LEDs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfLedsInput'
responses:
"200":
description: succesful operation
"400":
description: invalid colors or wrong amount of LEDs
/lights/{color}:
get:
tags:
@ -169,19 +187,47 @@ paths:
description: successful operation
components:
schemas:
ArrayOfLeds:
type: array
items:
RgbColorValues:
type: object
properties:
red:
type: integer
minimum: 0
maximum: 255
example: 255
green:
type: integer
minimum: 0
maximum: 255
example: 204
blue:
type: integer
minimum: 0
maximum: 255
example: 0
RgbColorHex:
type: object
properties:
hex:
type: string
pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
example: "#FFCC00"
RgbColorValueAndHex:
allOf:
- $ref: '#/components/schemas/RgbColorValues'
- $ref: '#/components/schemas/RgbColorHex'
RgbColorValueOrHex:
oneOf:
- $ref: '#/components/schemas/RgbColorValues'
- $ref: '#/components/schemas/RgbColorHex'
ArrayOfLeds:
type: array
items:
$ref: '#/components/schemas/RgbColorValueAndHex'
ArrayOfLedsInput:
type: array
items:
$ref: '#/components/schemas/RgbColorValueOrHex'
Settings:
type: object
properties: