From 80e7722598d06e1c533ffd28a92e26c784e23389 Mon Sep 17 00:00:00 2001 From: Carlos Valente <34649812+cpvalente@users.noreply.github.com> Date: Sun, 27 Feb 2022 21:42:16 +0100 Subject: [PATCH] Refact/1.2.0 (#22) * Create .pylintrc * refact: import order * refact: add missing docstring * refact: missing docstring * refact: prefer f strings * fix: prevent cancelling uninitiated object * refact: consistent return * refact: import order * refact: naming convention * Update README.md * refact: docstrings * version bump --- README.md | 3 +- setup.py | 2 +- stupidArtnet/.pylintrc | 568 +++++++++++++++++++++++++++++ stupidArtnet/ArtnetUtils.py | 3 + stupidArtnet/StupidArtnet.py | 181 ++++----- stupidArtnet/StupidArtnetServer.py | 32 +- stupidArtnet/__init__.py | 3 +- 7 files changed, 685 insertions(+), 107 deletions(-) create mode 100644 stupidArtnet/.pylintrc diff --git a/README.md b/README.md index 193d019..d3140e7 100644 --- a/README.md +++ b/README.md @@ -124,10 +124,11 @@ The spec for Artnet 4 applies here: 128 Nets contain 16 Subnets which contain 16 # Create a StupidArtnet instance with the relevant values # By default universe is simplified to a value between 0 - 255 +# this should suffice for anything not using subnets # on sending universe will be masked to two values # making the use of subnets invisible -universe = 17 +universe = 17 # equivalent to universe 1 subnet 1 a = StupidArtnet(target_ip, universe, packet_size) diff --git a/setup.py b/setup.py index 37ebe38..5d4ac4d 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setup(name='stupidArtnet', author='cpvalente', - version='1.2.0', + version='1.3.0', license='MIT', description='(Very) Simple implementation of the Art-Net protocol', long_description=long_description, diff --git a/stupidArtnet/.pylintrc b/stupidArtnet/.pylintrc new file mode 100644 index 0000000..2efaa58 --- /dev/null +++ b/stupidArtnet/.pylintrc @@ -0,0 +1,568 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths and can be in Posix or Windows format. +ignore-paths= + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.8 + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=no + +# Signatures are removed from the similarity computation +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/stupidArtnet/ArtnetUtils.py b/stupidArtnet/ArtnetUtils.py index 674459b..0f03941 100644 --- a/stupidArtnet/ArtnetUtils.py +++ b/stupidArtnet/ArtnetUtils.py @@ -1,3 +1,6 @@ +"""Provides common functions byte objects.""" + + def shift_this(number, high_first=True): """Utility method: extracts MSB and LSB from number. diff --git a/stupidArtnet/StupidArtnet.py b/stupidArtnet/StupidArtnet.py index f8b3743..a4d5ec5 100644 --- a/stupidArtnet/StupidArtnet.py +++ b/stupidArtnet/StupidArtnet.py @@ -10,8 +10,8 @@ import socket from threading import Timer -from stupidArtnet.ArtnetUtils import shift_this, put_in_range from time import sleep +from stupidArtnet.ArtnetUtils import shift_this, put_in_range class StupidArtnet(): @@ -19,7 +19,7 @@ class StupidArtnet(): UDP_PORT = 6454 - def __init__(self, targetIP='127.0.0.1', universe=0, packet_size=512, fps=30, + def __init__(self, target_ip='127.0.0.1', universe=0, packet_size=512, fps=30, even_packet_size=True, broadcast=False): """Initializes Art-Net Client. @@ -36,25 +36,26 @@ def __init__(self, targetIP='127.0.0.1', universe=0, packet_size=512, fps=30, """ # Instance variables - self.TARGET_IP = targetIP - self.SEQUENCE = 0 - self.PHYSICAL = 0 - self.UNIVERSE = universe - self.SUB = 0 - self.NET = 0 - self.PACKET_SIZE = put_in_range(packet_size, 2, 512, even_packet_size) - self.HEADER = bytearray() - self.BUFFER = bytearray(self.PACKET_SIZE) + self.target_ip = target_ip + self.sequence = 0 + self.physical = 0 + self.universe = universe + self.subnet = 0 + self.net = 0 + self.packet_size = put_in_range(packet_size, 2, 512, even_packet_size) + self.packet_header = bytearray() + self.buffer = bytearray(self.packet_size) - self.bMakeEven = even_packet_size + self.make_even = even_packet_size - self.bIsSimplified = True # simplify use of universe, net and subnet + self.is_simplified = True # simplify use of universe, net and subnet # UDP SOCKET - self.s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + self.socket_client = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) if broadcast: - self.s.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) + self.socket_client.setsockopt( + socket.SOL_SOCKET, socket.SO_BROADCAST, 1) # Timer self.fps = fps @@ -69,43 +70,43 @@ def __del__(self): def __str__(self): """Printable object state.""" - s = "===================================\n" - s += "Stupid Artnet initialized\n" - s += "Target IP: %s:%i \n" % (self.TARGET_IP, self.UDP_PORT) - s += "Universe: %i \n" % self.UNIVERSE - if not self.bIsSimplified: - s += "Subnet: %i \n" % self.SUB - s += "Net: %i \n" % self.NET - s += "Packet Size: %i \n" % self.PACKET_SIZE - s += "===================================" - - return s + state = "===================================\n" + state += "Stupid Artnet initialized\n" + state += f"Target IP: {self.target_ip} : {self.UDP_PORT} \n" + state += f"Universe: {self.universe} \n" + if not self.is_simplified: + state += f"Subnet: {self.subnet} \n" + state += f"Net: {self.net} \n" + state += f"Packet Size: {self.packet_size} \n" + state += "===================================" + + return state def make_header(self): """Make packet header.""" # 0 - id (7 x bytes + Null) - self.HEADER = bytearray() - self.HEADER.extend(bytearray('Art-Net', 'utf8')) - self.HEADER.append(0x0) + self.packet_header = bytearray() + self.packet_header.extend(bytearray('Art-Net', 'utf8')) + self.packet_header.append(0x0) # 8 - opcode (2 x 8 low byte first) - self.HEADER.append(0x00) - self.HEADER.append(0x50) # ArtDmx data packet + self.packet_header.append(0x00) + self.packet_header.append(0x50) # ArtDmx data packet # 10 - prototocol version (2 x 8 high byte first) - self.HEADER.append(0x0) - self.HEADER.append(14) + self.packet_header.append(0x0) + self.packet_header.append(14) # 12 - sequence (int 8), NULL for not implemented - self.HEADER.append(self.SEQUENCE) + self.packet_header.append(self.sequence) # 13 - physical port (int 8) - self.HEADER.append(0x00) + self.packet_header.append(0x00) # 14 - universe, (2 x 8 low byte first) - if self.bIsSimplified: + if self.is_simplified: # not quite correct but good enough for most cases: # the whole net subnet is simplified # by transforming a single uint16 into its 8 bit parts # you will most likely not see any differences in small networks - v = shift_this(self.UNIVERSE) # convert to MSB / LSB - self.HEADER.append(v[1]) - self.HEADER.append(v[0]) + msb, lsb = shift_this(self.universe) # convert to MSB / LSB + self.packet_header.append(lsb) + self.packet_header.append(msb) # 14 - universe, subnet (2 x 4 bits each) # 15 - net (7 bit value) else: @@ -117,28 +118,28 @@ def make_header(self): # this means 16 * 16 * 128 = 32768 universes per port # a subnet is a group of 16 Universes # 16 subnets will make a net, there are 128 of them - self.HEADER.append(self.SUB << 4 | self.UNIVERSE) - self.HEADER.append(self.NET & 0xFF) + self.packet_header.append(self.subnet << 4 | self.universe) + self.packet_header.append(self.net & 0xFF) # 16 - packet size (2 x 8 high byte first) - v = shift_this(self.PACKET_SIZE) # convert to MSB / LSB - self.HEADER.append(v[0]) - self.HEADER.append(v[1]) + msb, lsb = shift_this(self.packet_size) # convert to MSB / LSB + self.packet_header.append(msb) + self.packet_header.append(lsb) def show(self): """Finally send data.""" packet = bytearray() - packet.extend(self.HEADER) - packet.extend(self.BUFFER) + packet.extend(self.packet_header) + packet.extend(self.buffer) try: - self.s.sendto(packet, (self.TARGET_IP, self.UDP_PORT)) - except socket.error as e: - print("ERROR: Socket error with exception: %s" % e) + self.socket_client.sendto(packet, (self.target_ip, self.UDP_PORT)) + except socket.error as error: + print(f"ERROR: Socket error with exception: {error}") finally: - self.SEQUENCE = (self.SEQUENCE + 1) % 256 + self.sequence = (self.sequence + 1) % 256 def close(self): """Close UDP socket.""" - self.s.close() + self.socket_client.close() # THREADING # @@ -151,7 +152,8 @@ def start(self): def stop(self): """Stops thread clock.""" - self.__clock.cancel() + if self.__clock is not None: + self.__clock.cancel() # SETTERS - HEADER # @@ -163,10 +165,10 @@ def set_universe(self, universe): # This is ugly, trying to keep interface easy # With simplified mode the universe will be split into two # values, (uni and sub) which is correct anyway. Net will always be 0 - if self.bIsSimplified: - self.UNIVERSE = put_in_range(universe, 0, 255, False) + if self.is_simplified: + self.universe = put_in_range(universe, 0, 255, False) else: - self.UNIVERSE = put_in_range(universe, 0, 15, False) + self.universe = put_in_range(universe, 0, 15, False) self.make_header() def set_subnet(self, sub): @@ -174,7 +176,7 @@ def set_subnet(self, sub): Set simplify to false to use """ - self.SUB = put_in_range(sub, 0, 15, False) + self.subnet = put_in_range(sub, 0, 15, False) self.make_header() def set_net(self, net): @@ -182,30 +184,30 @@ def set_net(self, net): Set simplify to false to use """ - self.NET = put_in_range(net, 0, 127, False) + self.net = put_in_range(net, 0, 127, False) self.make_header() def set_packet_size(self, packet_size): """Setter for packet size (2 - 512, even only).""" - self.PACKET_SIZE = put_in_range(packet_size, 2, 512, self.bMakeEven) + self.packet_size = put_in_range(packet_size, 2, 512, self.make_even) self.make_header() # SETTERS - DATA # def clear(self): """Clear DMX buffer.""" - self.BUFFER = bytearray(self.PACKET_SIZE) + self.buffer = bytearray(self.packet_size) - def set(self, p): + def set(self, value): """Set buffer.""" - if len(self.BUFFER) != self.PACKET_SIZE: + if len(value) != self.packet_size: print("ERROR: packet does not match declared packet size") return - self.BUFFER = p + self.buffer = value def set_16bit(self, address, value, high_first=False): """Set single 16bit value in DMX buffer.""" - if address > self.PACKET_SIZE: + if address > self.packet_size: print("ERROR: Address given greater than defined packet size") return if address < 1 or address > 512 - 1: @@ -215,76 +217,77 @@ def set_16bit(self, address, value, high_first=False): # Check for endianess if high_first: - self.BUFFER[address - 1] = (value >> 8) & 0xFF # high - self.BUFFER[address] = (value) & 0xFF # low + self.buffer[address - 1] = (value >> 8) & 0xFF # high + self.buffer[address] = (value) & 0xFF # low else: - self.BUFFER[address - 1] = (value) & 0xFF # low - self.BUFFER[address] = (value >> 8) & 0xFF # high + self.buffer[address - 1] = (value) & 0xFF # low + self.buffer[address] = (value >> 8) & 0xFF # high def set_single_value(self, address, value): """Set single value in DMX buffer.""" - if address > self.PACKET_SIZE: + if address > self.packet_size: print("ERROR: Address given greater than defined packet size") return if address < 1 or address > 512: print("ERROR: Address out of range") return - self.BUFFER[address - 1] = put_in_range(value, 0, 255, False) + self.buffer[address - 1] = put_in_range(value, 0, 255, False) def set_single_rem(self, address, value): """Set single value while blacking out others.""" - if address > self.PACKET_SIZE: + if address > self.packet_size: print("ERROR: Address given greater than defined packet size") return if address < 1 or address > 512: print("ERROR: Address out of range") return self.clear() - self.BUFFER[address - 1] = put_in_range(value, 0, 255, False) + self.buffer[address - 1] = put_in_range(value, 0, 255, False) - def set_rgb(self, address, r, g, b): + def set_rgb(self, address, red, green, blue): """Set RGB from start address.""" - if address > self.PACKET_SIZE: + if address > self.packet_size: print("ERROR: Address given greater than defined packet size") return if address < 1 or address > 510: print("ERROR: Address out of range") return - self.BUFFER[address - 1] = put_in_range(r, 0, 255, False) - self.BUFFER[address] = put_in_range(g, 0, 255, False) - self.BUFFER[address + 1] = put_in_range(b, 0, 255, False) + self.buffer[address - 1] = put_in_range(red, 0, 255, False) + self.buffer[address] = put_in_range(green, 0, 255, False) + self.buffer[address + 1] = put_in_range(blue, 0, 255, False) # AUX Function # - def send(self, p): + def send(self, packet): """Set buffer and send straightaway. Args: array - integer array to send """ - self.set(p) + self.set(packet) self.show() - def set_simplified(self, bDoSimplify): + def set_simplified(self, simplify): """Builds Header accordingly. True - Header sends 16 bit universe value (OK but incorrect) False - Headers sends Universe - Net and Subnet values as protocol It is recommended that you set these values with .set_net() and set_physical """ - if bDoSimplify == self.bIsSimplified: + # avoid remaking header if there are no changes + if simplify == self.is_simplified: return - self.bIsSimplified = bDoSimplify + self.is_simplified = simplify self.make_header() def see_header(self): """Show header values.""" - print(self.HEADER) + print(self.packet_header) def see_buffer(self): """Show buffer values.""" - print(self.BUFFER) + print(self.buffer) def blackout(self): """Sends 0's all across.""" @@ -293,8 +296,7 @@ def blackout(self): def flash_all(self, delay=None): """Sends 255's all across.""" - packet = [255] * self.PACKET_SIZE - self.set(packet) + self.set([255] * self.packet_size) self.show() # Blackout after delay if delay: @@ -305,12 +307,11 @@ def flash_all(self, delay=None): if __name__ == '__main__': print("===================================") print("Namespace run") - target_ip = '127.0.0.1' # typically in 2.x or 10.x range - universe = 15 # see docs - packet_size = 20 # it is not necessary to send whole universe - packet = bytearray(packet_size) + TARGET_IP = '127.0.0.1' # typically in 2.x or 10.x range + UNIVERSE_TO_SEND = 15 # see docs + PACKET_SIZE = 20 # it is not necessary to send whole universe - a = StupidArtnet(target_ip, universe, packet_size) + a = StupidArtnet(TARGET_IP, UNIVERSE_TO_SEND, PACKET_SIZE) a.set_simplified(False) a.set_net(129) a.set_subnet(16) diff --git a/stupidArtnet/StupidArtnetServer.py b/stupidArtnet/StupidArtnetServer.py index e9f0a16..ac857e4 100644 --- a/stupidArtnet/StupidArtnetServer.py +++ b/stupidArtnet/StupidArtnetServer.py @@ -18,7 +18,7 @@ class StupidArtnetServer(): """(Very) simple implementation of an Artnet Server.""" UDP_PORT = 6454 - s = None + socket_server = None ARTDMX_HEADER = b'Art-Net\x00\x00P\x00\x0e' listeners = [] @@ -27,19 +27,20 @@ def __init__(self): # server active flag self.listen = True - self.th = Thread(target=self.__init_socket, daemon=True) - self.th.start() + self.server_thread = Thread(target=self.__init_socket, daemon=True) + self.server_thread.start() def __init_socket(self): """Initializes server socket.""" # Bind to UDP on the correct PORT - self.s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) - self.s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) - self.s.bind(('', self.UDP_PORT)) # Listen on any valid IP + self.socket_server = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + self.socket_server.setsockopt( + socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + self.socket_server.bind(('', self.UDP_PORT)) # Listen on any valid IP while self.listen: - data, unused_address = self.s.recvfrom(1024) + data, unused_address = self.socket_server.recvfrom(1024) # only dealing with Art-Net DMX if self.validate_header(data): @@ -62,9 +63,9 @@ def __del__(self): def __str__(self): """Printable object state.""" - s = "===================================\n" - s += "Stupid Artnet Listening\n" - return s + state = "===================================\n" + state += "Stupid Artnet Listening\n" + return state def register_listener(self, universe=0, sub=0, net=0, is_simplified=True, callback_function=None): @@ -118,7 +119,7 @@ def see_buffer(self, listener_id): """Show buffer values.""" for listener in self.listeners: if listener.get('id') == listener_id: - print(listener.get('buffer')) + return listener.get('buffer') return "Listener not found" @@ -130,6 +131,9 @@ def get_buffer(self, listener_id): print("Buffer object not found") return [] + print("No Listener with given id found") + return [] + def clear_buffer(self, listener_id): """Clear buffer in listener.""" for listener in self.listeners: @@ -159,7 +163,7 @@ def set_address_filter(self, listener_id, universe, sub=0, net=0, def close(self): """Close UDP socket.""" self.listen = False # Set flag - self.th.join() # Terminate thread once jobs are complete + self.server_thread.join() # Terminate thread once jobs are complete @staticmethod def validate_header(header): @@ -194,7 +198,7 @@ def test_callback(data): # Art-Net 4 definition specifies nets and subnets # Please see README and Art-Net user guide for details # Here we use the simplified default - universe = 1 + UNIVERSE_TO_LISTEN = 1 # Initilize server, this starts a server in the Art-Net port a = StupidArtnetServer() @@ -203,7 +207,7 @@ def test_callback(data): # add a new listener with a optional callback # the return is an id for the listener u1_listener = a.register_listener( - universe, callback_function=test_callback) + UNIVERSE_TO_LISTEN, callback_function=test_callback) # print object state print(a) diff --git a/stupidArtnet/__init__.py b/stupidArtnet/__init__.py index a23eb45..1c2eb72 100644 --- a/stupidArtnet/__init__.py +++ b/stupidArtnet/__init__.py @@ -1,3 +1,4 @@ -from .StupidArtnet import StupidArtnet +"""Facilitates library imports.""" from stupidArtnet.StupidArtnetServer import StupidArtnetServer from stupidArtnet.ArtnetUtils import shift_this, put_in_range, make_address_mask +from .StupidArtnet import StupidArtnet