send_umbrella.py

#!/usr/bin/env python3
#
# MIT License
#
# Copyright (c) 2017 Sebastian Bachmann
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import socket
import time
from struct import pack


class ArtNet(object):
    def __init__(self, dst="255.255.255.255", port=0x1936, universe=3, umbrellas=12):
        """
            A Simple wrapper for ArtNET.

            The umbreallas can only receive either RGB or WA information!
            It is not possible to send them RGBWA.
        """

        # NOTE: Artnet supports only 512 light values per universe.
        # By the way, we do not care that we should send at least 2 channels...
        if umbrellas * 5 > 512:
            raise ValueError("You can not send more than 512 channels per universe")

        if 0 < universe > 255:
            raise ValueError("Not a valid universe")

        self.seq = 0

        self.dst = dst
        self.port = port
        self.universe = universe
        self.umbrellas = umbrellas

        self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) # UDP
        self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)

        # A reuseable header
        #                    Protocol name               DMX         Version
        self.hdr = bytearray(b'Art-Net\x00') + bytearray([0, 0x50] + [0, 14])

    def sendrgb(self, r, g, b):
        """
            Send RGB information to the umbreallas

            param r: red channel (8 bit int)
            param g: green channel (8 bit int)
            param b: blue channel (8 bit int)
        """
        buf = bytearray([r, g, b, 0, 0] * self.umbrellas)
        self.sock.sendto(self.hdr + pack(">B", self.seq) + b'\x00' + pack("<H", self.universe) + pack(">H", len(buf)) + buf, (self.dst, self.port))
        self.seq = (self.seq + 1) % 256


    def sendwa(self, w, a):
        """
            Send White/Amber information to the umbreallas

            param w: white (cold white) channel (8 bit int)
            param a: amber (warm white) channel (8 bit int)
        """
        buf = bytearray([0, 0, 0, a, w] * self.umbrellas)
        self.sock.sendto(self.hdr + pack(">B", self.seq) + b'\x00' + pack("<H", self.universe) + pack(">H", len(buf)) + buf, (self.dst, self.port))
        self.seq = (self.seq + 1) % 256




if __name__ == "__main__":

    art = ArtNet(dst="10.20.255.255")

    art.sendrgb(255,255,255)
    time.sleep(1)
    art.sendrgb(0,255,255)
    time.sleep(1)
    art.sendrgb(0,0,255)
    time.sleep(1)
    art.sendrgb(0,255,0)
    time.sleep(1)
    art.sendrgb(255,0,0)
    time.sleep(1)

    art.sendwa(255,255)
    time.sleep(1)

    for i in range(255):
        art.sendwa(i, 0)

    for i in range(255):
        art.sendwa(0, i)