Closed MoJo2600 closed 3 years ago
My proposal for the api would be something like this
swagger: "2.0"
info:
version: "1.0.0"
title: "Pixelframe"
host: "localhost"
basePath: "/v1"
tags:
- name: "settings"
description: "Settings"
schemes:
- "http"
paths:
/settings:
post:
tags:
- "settings"
summary: "Change settings"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "settings to change"
required: true
schema:
type: object
properties:
brightness:
type: "integer"
minimum: 0
maximum: 255
responses:
"200":
description: "successful operation"
schema:
type: object
properties:
status:
type: "string"
default: "ok"
What do you think @KriegerTobias ?
Basic API design aligned and committed in b988cdc.
I think this is done
When the pixelframe is configured and running, it has a webserver running, which can be accessed with its IP or the url
pixelframe.local
. This website has a option to change settings. By changing thebrightness
setting, the brightness can be adjusted.Tasks: