Merge pull request #9 from noahhusby/v2.0

V2.0

aiorussound/__init__.py

@@ -1,7 +1,9 @@
+from .exceptions import UnsupportedFeature, CommandException, UnsupportedRussoundVersion, UncachedVariable
 from .rio import (
-        CommandException,
-        UncachedVariable,
-        ZoneID,
-        Russound)
+    Russound,
+    Controller,
+    Zone,
+    Source)
 
-__all__ = [CommandException, UncachedVariable, ZoneID, Russound]
+__all__ = ["CommandException", "UnsupportedFeature", "UnsupportedRussoundVersion", "UncachedVariable", "Russound",
+           "Controller", "Zone", "Source"]

aiorussound/const.py

@@ -0,0 +1,164 @@
+import json
+import re
+from collections import defaultdict
+from enum import Enum
+
+MAX_ZONES_KEY = "max_zones"
+RNET_SUPPORT_KEY = "rnet_support"
+
+MINIMUM_API_SUPPORT = "1.02.00"
+
+DEFAULT_PORT = 9621
+
+RECONNECT_DELAY = 5.0
+
+RESPONSE_REGEX = re.compile(
+    r"^(?:C\[(?P<controller>\d+)](?:\.Z\[(?P<zone>\d+)])?|S\[(?P<source>\d+)])?\.(?P<variable>\S+)=\s*\"("
+    r"?P<value>.*)\"$|^(?P<variable_only>\S+)=\s*\"(?P<value_only>.*)\"$"
+)
+
+
+# TODO: Add features 1.06.00 and up
+class FeatureFlag(Enum):
+    SUPPORT_POWER_MGMT = 1
+    SUPPORT_ZONE_PARAMETERS = 2
+    SUPPORT_SOURCE_PARAMETERS = 3
+    SUPPORT_CONTROLLER_PARAMETERS = 4
+    SUPPORT_SYSTEM_PARAMETERS = 5
+    SUPPORT_DMS_3_1_MM = 6
+    EVENT_KEY_CODE = 7
+    PROPERTY_IP_ADDRESS = 8
+    SUPPORT_SHUFFLE = 9
+    COMMAND_MM_CLOSE = 10
+    SUPPORT_PAGE_ZONE = 11
+    SUPPORT_REPEAT = 12
+    PROPERTY_CTRL_TYPE = 13
+    PROPERTY_SYS_LANG = 14
+    NOTIFICATION_SYS_LANG = 15
+    SUPPORT_MM_LONG_LIST = 16
+    TEMPLATES_MM_SCREEN = 17
+    PROPERTY_SLEEP_TIME_REMAINING = 18
+    SUPPORT_PRESETS_BANKS = 19
+    SUPPORT_FAVORITES = 20
+    SUPPORT_ZONE_SOURCE_EXCLUSION = 21
+    SUPPORT_FORMS = 22
+    SUPPORT_MEDIA_RATING = 23
+    SUPPORT_HIDDEN_ATTRIBUTE = 24
+    SUPPORT_SYSTEM_FAVORITE_RENAME = 25
+    COMMANDS_ZONE_MUTE_OFF_ON = 26
+    SUPPORT_WATCH_FAVORITES = 27
+    SUPPORT_SYSTEM = 28
+    SUPPORT_DEVICE_GROUPING = 29
+    SUPPORT_ALARM = 30
+    NOTIFICATION_ALARM_ZONE_WATCH = 31
+    PROPERTY_FIRMWARE_VERSION = 32
+    SUPPORT_MBX_DISPLAY_ITEMS = 33
+    PROPERTY_PLAY_STATUS = 34
+    PROPERTY_AVAILABLE_CONTROLS = 35
+    PROPERTY_SAMPLE_RATE = 36
+    PROPERTY_BIT_RATE = 37
+    PROPERTY_BIT_DEPTH = 38
+    PROPERTY_PLAY_TIME = 39
+    PROPERTY_TRACK_TIME = 40
+    PROPERTY_SET_SEEK_TIME = 41
+    SUPPORT_MM_CONTEXT_MENU = 42
+    PROPERTY_SLEEP_TIME_DEFAULT = 43
+    PROPERTY_SUPPORT_SLEEP_TIME = 44
+    EVENT_REBOOT = 45
+    SUPPORT_SYSTEM_FAVORITE_SOURCE = 46
+    ATTRIBUTE_USER_LOGIN = 47
+
+
+FLAGS_BY_VERSION = {
+    "1.01.00": [
+        FeatureFlag.SUPPORT_POWER_MGMT,
+    ],
+    "1.02.00": [
+        FeatureFlag.SUPPORT_ZONE_PARAMETERS,
+        FeatureFlag.SUPPORT_SOURCE_PARAMETERS,
+        FeatureFlag.SUPPORT_CONTROLLER_PARAMETERS,
+        FeatureFlag.SUPPORT_SYSTEM_PARAMETERS,
+    ],
+    "1.03.00": [
+        FeatureFlag.SUPPORT_DMS_3_1_MM,
+        FeatureFlag.EVENT_KEY_CODE,
+        FeatureFlag.PROPERTY_IP_ADDRESS
+    ],
+    "1.04.00": [
+        FeatureFlag.SUPPORT_SHUFFLE,
+        FeatureFlag.COMMAND_MM_CLOSE,
+        FeatureFlag.SUPPORT_PAGE_ZONE,
+    ],
+    "1.05.00": [
+        FeatureFlag.SUPPORT_REPEAT,
+        FeatureFlag.PROPERTY_CTRL_TYPE,
+        FeatureFlag.PROPERTY_SYS_LANG,
+    ],
+    "1.06.00": [
+        FeatureFlag.NOTIFICATION_SYS_LANG,
+        FeatureFlag.SUPPORT_MM_LONG_LIST,
+        FeatureFlag.TEMPLATES_MM_SCREEN,
+    ],
+    "1.07.00": [
+        FeatureFlag.PROPERTY_SLEEP_TIME_REMAINING,
+        FeatureFlag.SUPPORT_PRESETS_BANKS,
+        FeatureFlag.SUPPORT_FAVORITES,
+        FeatureFlag.SUPPORT_ZONE_SOURCE_EXCLUSION,
+        FeatureFlag.SUPPORT_FORMS,
+        FeatureFlag.SUPPORT_MEDIA_RATING,
+        FeatureFlag.SUPPORT_HIDDEN_ATTRIBUTE,
+    ],
+    "1.08.00": [
+        FeatureFlag.SUPPORT_SYSTEM_FAVORITE_RENAME
+    ],
+    "1.09.00": [
+        FeatureFlag.COMMANDS_ZONE_MUTE_OFF_ON,
+    ],
+    "1.11.00": [
+        FeatureFlag.SUPPORT_WATCH_FAVORITES,
+    ],
+    "1.12.00": [
+        FeatureFlag.SUPPORT_SYSTEM,
+        FeatureFlag.SUPPORT_DEVICE_GROUPING,
+        FeatureFlag.SUPPORT_ALARM,
+    ],
+    "1.12.01": [
+        FeatureFlag.NOTIFICATION_ALARM_ZONE_WATCH,
+    ],
+    "1.12.02": [
+        FeatureFlag.PROPERTY_FIRMWARE_VERSION,
+    ],
+    "1.14.00": [
+        FeatureFlag.SUPPORT_MBX_DISPLAY_ITEMS,
+        FeatureFlag.PROPERTY_PLAY_STATUS,
+        FeatureFlag.PROPERTY_AVAILABLE_CONTROLS,
+        FeatureFlag.PROPERTY_SAMPLE_RATE,
+        FeatureFlag.PROPERTY_BIT_RATE,
+        FeatureFlag.PROPERTY_BIT_DEPTH,
+        FeatureFlag.PROPERTY_PLAY_TIME,
+        FeatureFlag.PROPERTY_TRACK_TIME,
+        FeatureFlag.PROPERTY_SET_SEEK_TIME,
+        FeatureFlag.SUPPORT_MM_CONTEXT_MENU
+    ],
+    "1.14.01": [
+        FeatureFlag.PROPERTY_SLEEP_TIME_DEFAULT,
+        FeatureFlag.PROPERTY_SUPPORT_SLEEP_TIME,
+    ],
+    "1.15.00": [
+        FeatureFlag.EVENT_REBOOT,
+        FeatureFlag.SUPPORT_SYSTEM_FAVORITE_SOURCE
+    ],
+    "1.15.02": [
+        FeatureFlag.ATTRIBUTE_USER_LOGIN,
+    ],
+}
+
+VERSIONS_BY_FLAGS = defaultdict(list)
+
+for version, flags in FLAGS_BY_VERSION.items():
+    for flag in flags:
+        VERSIONS_BY_FLAGS[flag] = version
+
+# Each controller is separated to support future differences in features
+with open('aiorussound/devices.json') as json_file:
+    CONTROLLER_ATTR = json.load(json_file)

aiorussound/devices.json

@@ -0,0 +1,46 @@
+{
+    "MBX-PRE": {
+        "max_zones": 1,
+        "rnet_support": false
+    },
+    "MBX-AMP": {
+        "max_zones": 1,
+        "rnet_support": false
+    },
+    "MCA-C3": {
+        "max_zones": 6,
+        "rnet_support": true
+    },
+    "MCA-C5": {
+        "max_zones": 8,
+        "rnet_support": true
+    },
+    "MCA-66": {
+        "max_zones": 6,
+        "rnet_support": true
+    },
+    "MCA-88": {
+        "max_zones": 8,
+        "rnet_support": true
+    },
+    "MCA-88X": {
+        "max_zones": 8,
+        "rnet_support": true
+    },
+    "XSource": {
+        "max_zones": 1,
+        "rnet_support": false
+    },
+    "XZone4": {
+        "max_zones": 1,
+        "rnet_support": false
+    },
+    "XZone70V": {
+        "max_zones": 1,
+        "rnet_support": false
+    },
+    "XStream-X5": {
+        "max_zones": 1,
+        "rnet_support": false
+    }
+}

aiorussound/exceptions.py

@@ -0,0 +1,21 @@
+class CommandException(Exception):
+    """A command sent to the controller caused an error."""
+
+    pass
+
+
+class UncachedVariable(Exception):
+    """A variable was not found in the cache."""
+
+    pass
+
+
+class UnsupportedFeature(Exception):
+    """A requested command is not supported on this controller"""
+    pass
+
+
+class UnsupportedRussoundVersion(Exception):
+    """The client implements an unsupported version of the Russound RIO API"""
+    pass
+