File size: 17,442 Bytes
4181d9c a8d5902 4181d9c |
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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# Copyright (c) 2017-2022 Mathias Funk
# This software is released under the MIT License.
# http://opensource.org/licenses/mit-license.php
import json
import socket
import threading
import atexit
import time
import uuid
from math import fsum
class OOCSI:
def __init__(self, handle=None, host='localhost', port=8080, callback=None, logger=None, maxReconnectionAttempts=100000):
if handle is None or len(handle.strip()) == 0:
self.handle = "OOCSIClient_" + uuid.uuid4().__str__().replace('-', '')[0:15];
else:
self.handle = handle
self.receivers = {self.handle: [callback]}
self.calls = {}
self.services = {}
self.reconnect = True
self.maxReconnects = maxReconnectionAttempts
self.connected = False
if logger is not None:
self.log = logger
# Connect the socket to the port where the server is listening
self.server_address = (host, port)
self.log('connecting to %s port %s' % self.server_address)
# start the connection
# (block till we are connected or connection error/timeout)
if not self.connect():
self.log('Initial OOCSI connection failed')
raise OOCSIDisconnect('OOCSI has not been found')
# start the connection thread
self.runtime = OOCSIThread(self)
self.runtime.start()
def connect(self):
connectionSuccessful = False
try:
# Create a TCP/IP socket
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.sock.connect(self.server_address)
self.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
try:
# Send data
message = self.handle + '(JSON)'
self.internalSend(message)
data = self.sock.recv(1024).decode()
if data.startswith('{'):
connectionSuccessful = True
self.log('connection established')
# re-subscribe for channels
for channelName in self.receivers:
self.internalSend('subscribe {0}'.format(channelName))
self.connected = True
elif data.startswith('error'):
self.log(data)
self.reconnect = False
finally:
pass
except:
pass
return connectionSuccessful
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.stop()
def log(self, message):
print('[{0}]: {1}'.format(self.handle, message))
def internalSend(self, msg):
try:
self.sock.sendall((msg + '\n').encode())
except:
self.connected = False
def loop(self):
try:
data = self.sock.recv(4 * 1024 * 1024).decode()
lines = data.split("\n")
for line in lines:
if len(data) == 0:
self.sock.close()
self.connected = False
elif line.startswith('ping') or line.startswith('.'):
self.internalSend('.')
elif line.startswith('{'):
self.receive(json.loads(line))
except:
pass
def receive(self, event):
sender = event['sender']
recipient = event['recipient']
# clean up the event
del event['recipient']
del event['sender']
del event['timestamp']
if 'data' in event:
del event['data']
if '_MESSAGE_HANDLE' in event and event['_MESSAGE_HANDLE'] in self.services:
service = self.services[event['_MESSAGE_HANDLE']]
del event['_MESSAGE_HANDLE']
service(event)
self.send(sender, event)
self.receiveChannelEvent(sender, recipient, event)
else:
if '_MESSAGE_ID' in event:
myCall = self.calls[event['_MESSAGE_ID']]
if myCall['expiration'] > time.time():
response = self.calls[event['_MESSAGE_ID']]
response['response'] = event
del response['expiration']
del response['_MESSAGE_ID']
del response['response']['_MESSAGE_ID']
else:
del self.calls[event['_MESSAGE_ID']]
else:
self.receiveChannelEvent(sender, recipient, event)
def receiveChannelEvent(self, sender, recipient, event):
if recipient in self.receivers and self.receivers[recipient] != None:
for x in self.receivers[recipient]:
x(sender, recipient, event)
def send(self, channelName, data):
self.internalSend('sendraw {0} {1}'.format(channelName, json.dumps(data)))
def call(self, channelName, callName, data, timeout = 1):
data['_MESSAGE_HANDLE'] = callName
data['_MESSAGE_ID'] = uuid.uuid4().__str__()
self.calls[data['_MESSAGE_ID']] = {'_MESSAGE_HANDLE': callName, '_MESSAGE_ID': data['_MESSAGE_ID'], 'expiration': time.time() + timeout}
self.send(channelName, data)
return self.calls[data['_MESSAGE_ID']]
def callAndWait(self, channelName, callName, data, timeout = 1):
call = self.call(channelName, callName, data, timeout)
expiration = time.time() + timeout
while time.time() < expiration:
time.sleep(0.1)
if 'response' in call:
break;
# self.calls.append
return call
def register(self, channelName, callName, callback):
self.services[callName] = callback
self.internalSend('subscribe {0}'.format(channelName))
self.log('registered responder on {0} for {1}'.format(channelName, callName))
def subscribe(self, channelName, f):
if channelName in self.receivers:
self.receivers[channelName].append(f)
else:
self.receivers[channelName] = [f]
self.internalSend('subscribe {0}'.format(channelName))
self.log('subscribed to {0}'.format(channelName))
def unsubscribe(self, channelName):
del self.receivers[channelName]
self.internalSend('unsubscribe {0}'.format(channelName))
self.log('unsubscribed from {0}'.format(channelName))
def variable(self, channelName, key):
return OOCSIVariable(self, channelName, key)
def stop(self):
self.reconnect = False
self.internalSend('quit')
self.sock.close()
self.connected = False
def handleEvent(self, sender, receiver, message):
{}
def returnHandle(self):
return self.handle
def heyOOCSI(self, custom_name=None):
if custom_name is None:
return (OOCSIDevice(self, self.handle))
else:
return (OOCSIDevice(self, custom_name))
class OOCSIThread(threading.Thread):
def __init__(self, parent=None):
self.parent = parent
super(OOCSIThread, self).__init__()
def run(self):
# register exit handler
atexit.register(self._stop)
# run the established connection
while self.parent.connected:
self.parent.loop()
# reconnect
if self.parent.reconnect:
failedConnectionAttempts = 0
while self.parent.reconnect:
self.parent.log('re-connecting to OOCSI')
if self.parent.connect():
failedConnectionAttempts = 0
while self.parent.connected:
self.parent.loop()
else:
failedConnectionAttempts += 1
time.sleep(5)
# raise exception after unsuccessful connection attempts
if failedConnectionAttempts == self.parent.maxReconnects:
self.parent.log('OOCSI connection failed after 10 attempts')
raise OOCSIDisconnect('OOCSI has not been found')
self.parent.log('closing connection to OOCSI')
def _stop(self):
self.parent.stop()
return threading.Thread._stop(self)
class OOCSIDisconnect(Exception):
pass
class OOCSICall:
def __init__(self, parent=None):
self.uuid = uuid.uuid4()
self.expiration = time.time()
class OOCSIVariable(object):
def __init__(self, oocsi, channelName, key):
self.key = key
self.channel = channelName
oocsi.subscribe(channelName, self.internalReceiveValue)
self.oocsi = oocsi
self.value = None
self.windowLength = 0
self.values = []
self.minvalue = None
self.maxvalue = None
self.sigma = None
def get(self):
if self.windowLength > 0 and len(self.values) > 0:
return fsum(self.values)/float(len(self.values))
else:
return self.value
def set(self, value):
tempvalue = value
if not self.minvalue is None and tempvalue < self.minvalue:
tempvalue = self.minvalue
elif not self.maxvalue is None and tempvalue > self.maxvalue:
tempvalue = self.maxvalue
elif not self.sigma is None:
mean = self.get()
if not mean is None:
if abs(mean - tempvalue) > self.sigma:
if mean - tempvalue > 0:
tempvalue = mean - self.sigma/float(len(self.values))
else:
tempvalue = mean + self.sigma/float(len(self.values))
if self.windowLength > 0:
self.values.append(tempvalue)
self.values = self.values[-self.windowLength:]
else:
self.value = tempvalue
self.oocsi.send(self.channel, {self.key: value})
def internalReceiveValue(self, sender, recipient, data):
if self.key in data:
tempvalue = data[self.key]
if not self.minvalue is None and tempvalue < self.minvalue:
tempvalue = self.minvalue
elif not self.maxvalue is None and tempvalue > self.maxvalue:
tempvalue = self.maxvalue
elif not self.sigma is None:
mean = self.get()
if not mean is None:
if abs(mean - tempvalue) > self.sigma:
if mean - tempvalue > 0:
tempvalue = mean - self.sigma/float(len(self.values))
else:
tempvalue = mean + self.sigma/float(len(self.values))
if self.windowLength > 0:
self.values.append(tempvalue)
self.values = self.values[-self.windowLength:]
else:
self.value = tempvalue
def min(self, minvalue):
self.minvalue = minvalue
if self.value < self.minvalue:
self.value = self.minvalue
return self
def max(self, maxvalue):
self.maxvalue = maxvalue
if self.value > self.maxvalue:
self.value = self.maxvalue
return self
def smooth(self, windowLength, sigma=None):
self.windowLength = windowLength
self.sigma = sigma
return self
class OOCSIDevice():
def __init__(self, OOCSI, device_name:str) -> None:
self._device_name = device_name
self._device = {self._device_name:{}}
self._device[self._device_name]["properties"] = {}
self._device[self._device_name]["properties"]["device_id"] = OOCSI.returnHandle()
self._device[self._device_name]["components"] = {}
self._device[self._device_name]["location"] = {}
self._components = self._device[self._device_name]["components"]
self._oocsi=OOCSI
self._oocsi.log(f'Created device {self._device_name}.')
def addProperty(self, properties:str, propertyValue):
self._device[self._device_name]["properties"][properties] = propertyValue
self._oocsi.log(f'Added {properties} to the properties list of device {self._device_name}.')
return self
def addLocation(self, location_name:str, latitude:float = 0, longitude:float = 0):
self._device[self._device_name]["location"][location_name] = [latitude, longitude]
self._oocsi.log(f'Added {location_name} to the locations list of device {self._device_name}.')
return self
def addSensor(self, sensor_name:str, sensor_channel:str, sensor_type:str, sensor_unit:str, sensor_default:float, mode:str = "auto", step:float = None, icon:str = None):
self._components[sensor_name]={}
self._components[sensor_name]["channel_name"] = sensor_channel
self._components[sensor_name]["type"] = "sensor"
self._components[sensor_name]["sensor_type"] = sensor_type
self._components[sensor_name]["unit"] = sensor_unit
self._components[sensor_name]["value"] = sensor_default
self._components[sensor_name]["mode"] = mode
self._components[sensor_name]["step"] = step
self._components[sensor_name]["icon"] = icon
self._device[self._device_name]["components"][sensor_name] = self._components[sensor_name]
self._oocsi.log(f'Added {sensor_name} to the components list of device {self._device_name}.')
return self
def addNumber(self, number_name:str, number_channel:str, number_min_max, number_unit:str, number_default:float, icon:str = None):
self._components[number_name]={}
self._components[number_name]["channel_name"] = number_channel
self._components[number_name]["min_max"]= number_min_max
self._components[number_name]["type"] = "number"
self._components[number_name]["unit"] = number_unit
self._components[number_name]["value"] = number_default
self._components[number_name]["icon"] = icon
self._device[self._device_name]["components"][number_name] = self._components[number_name]
self._oocsi.log(f'Added {number_name} to the components list of device {self._device_name}.')
return self
def addBinarySensor(self, sensor_name:str, sensor_channel:str, sensor_type:str, sensor_default:bool = False, icon:str = None):
self._components[sensor_name]={}
self._components[sensor_name]["channel_name"] = sensor_channel
self._components[sensor_name]["type"] = "binary_sensor"
self._components[sensor_name]["sensor_type"] = sensor_type
self._components[sensor_name]["state"] = sensor_default
self._components[sensor_name]["icon"] = icon
self._device[self._device_name]["components"][sensor_name] = self._components[sensor_name]
self._oocsi.log(f'Added {sensor_name} to the components list of device {self._device_name}.')
return self
def addSwitch(self, switch_name:str, switch_channel:str, switch_default:bool = False, icon:str = None):
self._components[switch_name]={}
self._components[switch_name]["channel_name"] = switch_channel
self._components[switch_name]["type"] = "switch"
self._components[switch_name]["state"] = switch_default
self._components[switch_name]["icon"] = icon
self._device[self._device_name]["components"][switch_name] = self._components[switch_name]
self._oocsi.log(f'Added {switch_name} to the components list of device {self._device_name}.')
return self
def addLight(self, light_name:str, light_channel:str, led_type:str, spectrum, light_default_state:bool = False, light_default_brightness:int = 0, mired_min_max = None, icon:str = None):
SPECTRUM = ["WHITE","CCT","RGB"]
LEDTYPE = ["RGB","RGBW","RGBWW","CCT","DIMMABLE","ONOFF"]
self._components[light_name]={}
if led_type in LEDTYPE:
if spectrum in SPECTRUM:
self._components[light_name]["spectrum"] = spectrum
else:
self._oocsi.log(f'error, {light_name} spectrum does not exist.')
pass
else:
self._oocsi.log(f'error, {light_name} ledtype does not exist.')
pass
self._components[light_name]["channel_name"] = light_channel
self._components[light_name]["type"] = "light"
self._components[light_name]["ledType"] = led_type
self._components[light_name]["spectrum"] = spectrum
self._components[light_name]["min_max"]= mired_min_max
self._components[light_name]["state"] = light_default_state
self._components[light_name]["brightness"] = light_default_brightness
self._components[light_name]["icon"] = icon
self._device[self._device_name]["components"][light_name] = self._components[light_name]
self._oocsi.log(f'Added {light_name} to the components list of device {self._device_name}.')
return self
def submit(self):
data = self._device
self._oocsi.internalSend('sendraw {0} {1}'.format("heyOOCSI!", json.dumps(data)))
self._oocsi.log(f'Sent heyOOCSI! message for device {self._device_name}.')
def sayHi(self):
self.submit()
|