craftbeerpi4-pione/cbpi/http_endpoints/http_kettle.py

277 lines
7.2 KiB
Python
Raw Normal View History

2019-01-02 21:20:44 +01:00
from aiohttp import web
2019-01-05 20:43:48 +01:00
from cbpi.api import *
2019-01-02 21:20:44 +01:00
auth = False
2021-01-22 23:25:20 +01:00
class KettleHttpEndpoints():
2019-01-02 21:20:44 +01:00
2021-01-22 23:25:20 +01:00
def __init__(self, cbpi):
self.cbpi = cbpi
self.controller = cbpi.kettle
self.cbpi.register(self, "/kettle")
2019-01-14 07:33:59 +01:00
@request_mapping(path="/", auth_required=False)
async def http_get_all(self, request):
"""
---
2021-01-22 23:25:20 +01:00
description: Switch actor on
2019-01-14 07:33:59 +01:00
tags:
- Kettle
responses:
"204":
description: successful operation
"""
2021-01-22 23:25:20 +01:00
return web.json_response(data=self.controller.get_state())
2019-01-14 07:33:59 +01:00
@request_mapping(path="/", method="POST", auth_required=False)
async def http_add(self, request):
"""
---
2021-01-22 23:25:20 +01:00
description: add one Actor
2019-01-14 07:33:59 +01:00
tags:
- Kettle
parameters:
- in: body
name: body
2021-01-22 23:25:20 +01:00
description: Created an actor
required: true
2019-01-14 07:33:59 +01:00
schema:
type: object
2021-01-22 23:25:20 +01:00
2019-01-14 07:33:59 +01:00
properties:
name:
type: string
sensor:
type: "integer"
format: "int64"
heater:
type: "integer"
format: "int64"
agitator:
type: "integer"
format: "int64"
target_temp:
type: "integer"
format: "int64"
2021-01-22 23:25:20 +01:00
type:
2019-01-14 07:33:59 +01:00
type: string
2021-01-22 23:25:20 +01:00
props:
2019-01-14 07:33:59 +01:00
type: object
2021-01-22 23:25:20 +01:00
example:
name: "Kettle 1"
type: "CustomKettleLogic"
props: {}
2019-01-14 07:33:59 +01:00
responses:
"204":
description: successful operation
"""
2021-01-22 23:25:20 +01:00
data = await request.json()
response_data = await self.controller.add(data)
return web.json_response(data=self.controller.create_dict(response_data))
2019-01-14 07:33:59 +01:00
@request_mapping(path="/{id}", method="PUT", auth_required=False)
async def http_update(self, request):
"""
---
2021-01-22 23:25:20 +01:00
description: Update an actor
2019-01-14 07:33:59 +01:00
tags:
- Kettle
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-14 07:33:59 +01:00
required: true
type: "integer"
format: "int64"
- in: body
name: body
2021-01-22 23:25:20 +01:00
description: Update an actor
2019-01-14 07:33:59 +01:00
required: false
schema:
type: object
properties:
name:
type: string
2021-01-22 23:25:20 +01:00
type:
2019-01-14 07:33:59 +01:00
type: string
config:
2021-01-22 23:25:20 +01:00
props: object
2019-01-14 07:33:59 +01:00
responses:
2021-01-22 23:25:20 +01:00
"200":
2019-01-14 07:33:59 +01:00
description: successful operation
"""
2021-01-22 23:25:20 +01:00
id = request.match_info['id']
data = await request.json()
return web.json_response(data=self.controller.create_dict(await self.controller.update(id, data)))
2019-01-14 07:33:59 +01:00
@request_mapping(path="/{id}", method="DELETE", auth_required=False)
async def http_delete_one(self, request):
"""
---
2021-01-22 23:25:20 +01:00
description: Delete an actor
2019-01-14 07:33:59 +01:00
tags:
- Kettle
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-14 07:33:59 +01:00
required: true
2021-01-22 23:25:20 +01:00
type: "string"
2019-01-14 07:33:59 +01:00
responses:
"204":
description: successful operation
"""
2021-01-22 23:25:20 +01:00
id = request.match_info['id']
await self.controller.delete(id)
2019-01-02 21:20:44 +01:00
return web.Response(status=204)
2021-01-22 23:25:20 +01:00
@request_mapping(path="/{id}/on", method="POST", auth_required=False)
async def http_on(self, request) -> web.Response:
2019-01-14 07:33:59 +01:00
"""
2019-01-02 21:20:44 +01:00
2019-01-14 07:33:59 +01:00
---
2021-01-22 23:25:20 +01:00
description: Switch actor on
2019-01-14 07:33:59 +01:00
tags:
- Kettle
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-14 07:33:59 +01:00
required: true
2021-01-22 23:25:20 +01:00
type: "string"
2019-01-14 07:33:59 +01:00
responses:
"204":
description: successful operation
2021-01-22 23:25:20 +01:00
"405":
description: invalid HTTP Met
2019-01-14 07:33:59 +01:00
"""
2021-01-22 23:25:20 +01:00
id = request.match_info['id']
await self.controller.start(id)
2019-01-02 21:20:44 +01:00
return web.Response(status=204)
2021-01-22 23:25:20 +01:00
@request_mapping(path="/{id}/off", method="POST", auth_required=False)
async def http_off(self, request) -> web.Response:
2019-01-14 07:33:59 +01:00
"""
2019-01-02 21:20:44 +01:00
2019-01-14 07:33:59 +01:00
---
2021-01-22 23:25:20 +01:00
description: Switch actor on
2019-01-14 07:33:59 +01:00
tags:
- Kettle
2021-01-22 23:25:20 +01:00
2019-01-14 07:33:59 +01:00
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-14 07:33:59 +01:00
required: true
2021-01-22 23:25:20 +01:00
type: "string"
2019-01-14 07:33:59 +01:00
responses:
"204":
description: successful operation
2021-01-22 23:25:20 +01:00
"405":
description: invalid HTTP Met
2019-01-14 07:33:59 +01:00
"""
2021-01-22 23:25:20 +01:00
id = request.match_info['id']
await self.controller.off(id)
2019-01-02 21:20:44 +01:00
return web.Response(status=204)
2021-01-22 23:25:20 +01:00
2021-01-30 22:29:33 +01:00
@request_mapping(path="/{id}/toggle", method="POST", auth_required=False)
async def http_toggle(self, request) -> web.Response:
"""
---
description: Switch actor on
tags:
- Kettle
parameters:
- name: "id"
in: "path"
description: "Kettle ID"
required: true
type: "string"
responses:
"204":
description: successful operation
"405":
description: invalid HTTP Met
"""
id = request.match_info['id']
await self.controller.toggle(id)
return web.Response(status=204)
2019-01-02 21:20:44 +01:00
2021-01-22 23:25:20 +01:00
@request_mapping(path="/{id}/action", method="POST", auth_required=auth)
async def http_action(self, request) -> web.Response:
2019-01-14 07:33:59 +01:00
"""
2019-01-02 21:20:44 +01:00
2019-01-17 22:11:55 +01:00
---
2021-01-22 23:25:20 +01:00
description: Toogle an actor on or off
2019-01-17 22:11:55 +01:00
tags:
- Kettle
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-17 22:11:55 +01:00
required: true
type: "integer"
format: "int64"
2021-01-22 23:25:20 +01:00
- in: body
name: body
description: Update an actor
required: false
schema:
type: object
properties:
name:
type: string
parameter:
type: object
2019-01-17 22:11:55 +01:00
responses:
"204":
description: successful operation
"""
2021-01-22 23:25:20 +01:00
actor_id = request.match_info['id']
data = await request.json()
await self.controller.call_action(actor_id, data.get("name"), data.get("parameter"))
2019-01-17 22:11:55 +01:00
2021-01-22 23:25:20 +01:00
return web.Response(status=204)
@request_mapping(path="/{id}/target_temp", method="POST", auth_required=auth)
async def http_target(self, request) -> web.Response:
2019-01-14 07:33:59 +01:00
"""
2021-01-22 23:25:20 +01:00
2019-01-14 07:33:59 +01:00
---
2021-01-22 23:25:20 +01:00
description: Toogle an actor on or off
2019-01-14 07:33:59 +01:00
tags:
- Kettle
parameters:
- name: "id"
in: "path"
2021-01-22 23:25:20 +01:00
description: "Actor ID"
2019-01-14 07:33:59 +01:00
required: true
type: "integer"
format: "int64"
2021-01-30 22:29:33 +01:00
- in: body
name: body
description: Update Temp
required: true
schema:
type: object
properties:
temp:
type: integer
2019-01-14 07:33:59 +01:00
responses:
"204":
description: successful operation
"""
2021-01-22 23:25:20 +01:00
id = request.match_info['id']
2021-01-30 22:29:33 +01:00
data = await request.json()
await self.controller.set_target_temp(id,data.get("temp"))
2021-01-22 23:25:20 +01:00
return web.Response(status=204)