craftbeerpi4-pione/cbpi/api/actor.py

76 lines
1.7 KiB
Python
Raw Normal View History

2019-01-05 20:43:48 +01:00
from abc import ABCMeta
2021-01-22 23:25:20 +01:00
import asyncio
2019-01-05 20:43:48 +01:00
from cbpi.api.extension import CBPiExtension
2021-02-06 00:41:50 +01:00
from cbpi.api.config import ConfigType
2019-01-05 20:43:48 +01:00
2021-01-23 14:41:26 +01:00
__all__ = ["CBPiActor"]
2019-01-05 20:43:48 +01:00
import logging
logger = logging.getLogger(__file__)
2021-01-23 14:41:26 +01:00
class CBPiActor(metaclass=ABCMeta):
2021-01-22 23:25:20 +01:00
def __init__(self, cbpi, id, props):
self.cbpi = cbpi
self.id = id
self.props = props
self.logger = logging.getLogger(__file__)
self.data_logger = None
self.state = False
self.running = False
def init(self):
pass
def log_data(self, value):
self.cbpi.log.log_data(self.id, value)
async def run(self):
while self.running:
await asyncio.sleep(1)
def get_state(self):
return dict(state=self.state)
async def start(self):
self.running = True
async def stop(self):
self.running = False
2021-02-06 00:41:50 +01:00
def get_static_config_value(self,name,default):
return self.cbpi.static_config.get(name, default)
def get_config_value(self,name,default):
return self.cbpi.config.get(name, default=default)
async def set_config_value(self,name,value):
return await self.cbpi.config.set(name,value)
async def add_config_value(self, name, value, type: ConfigType, description, options=None):
await self.cbpi.add(name, value, type, description, options=None)
2021-01-22 23:25:20 +01:00
async def on(self, power):
'''
Code to switch the actor on. Power is provided as integer value
:param power: power value between 0 and 100
:return: None
'''
pass
async def off(self):
'''
Code to switch the actor off
:return: None
'''
pass