python-mobius 0.8.3__py3-none-any.whl → 0.9.0__py3-none-any.whl

mobius/__init__.py

@@ -1,13 +1,11 @@
 """
 python-mobius: a reverse-engineered Python client for the BLE protocol used
 by EcoTech Marine (VorTech, Radion), AquaIllumination (Prime, Hydra),
-Neptune Systems, and NYOS "Mobius"-branded aquarium devices.
+Neptune Systems and NYOS "Mobius" aquarium devices.
 
 Not affiliated with or endorsed by any of those companies. This is an
-independent reimplementation of the wire protocol for interoperability,
-derived from public community reverse-engineering work and analysis of the
-publicly-distributed Mobius Android app. See documentation/ for the full
-protocol writeup and confirmation evidence for every field.
+independent implementation of the wire protocol for interoperability. See
+documentation/ for the protocol description.
 """
 
 from .crc import crc16, CRC16_TABLE
@@ -22,9 +20,10 @@ from .frame import (
 )
 from .constants import (
     PrimitiveType, PRIMITIVE_SIZE, LIGHT_PRIMITIVES,
-    PUMP_PRIMITIVES_VERIFIED, PUMP_PRIMITIVES_EXPERIMENTAL,
+    PUMP_PRIMITIVES_VERIFIED, PUMP_PRIMITIVES_EXPERIMENTAL, PUMP_PRIMITIVES, enum_or_none,
+    primitive_type_from_name, support_tier, PumpParamRange, pump_param_range, pump_param_errors,
     Model, MODEL_MANUFACTURER, manufacturer_for_model,
-    ErrorState, C2Attribute, PhysicalValueID, VisualID,
+    ErrorState, C2Attribute, OperationMode, PhysicalValueID, VisualID,
     SceneID, OperationState, FsciStatus,
     PumpMode, PumpOverrideMode, RampType, PumpParam, PUMP_PARAM_SIZE, PUMP_MODE_PARAMS,
     supported_pump_modes,
@@ -37,11 +36,11 @@ from .schedule import (
     LightPrimitive, SchedulePoint, interpolate_light_schedule,
     PumpPrimitiveValue, PumpSchedulePoint, get_active_pump_block,
     light_schedule_to_dict, light_schedule_from_dict,
-    pump_schedule_to_dict, pump_schedule_from_dict,
+    pump_schedule_to_dict, pump_schedule_from_dict, pump_params_to_dict,
     MAX_PUMP_SCHEDULE_POINT_SIZE,
 )
 from .scenes import Scene, ActiveScene, decode_configured_scenes, decode_active_scene
-from .manufacturer import MOBIUS_COMPANY_ID_ECOTECH, MOBIUS_COMPANY_ID_AQUAILLUMINATION, MOBIUS_COMPANY_IDS, MobiusAdvertisement, parse_manufacturer_data
+from .manufacturer import MOBIUS_COMPANY_ID_ECOTECH, MOBIUS_COMPANY_ID_AQUAILLUMINATION, MOBIUS_COMPANY_IDS, MobiusAdvertisement, parse_manufacturer_data, parse_advertisement
 from .modifiers import (
     AcclimationInfo, is_night_segment,
     julian_day_from_date, lunar_days_into_phase, lunar_percent_reduction,
@@ -58,11 +57,12 @@ from .coap import (
 from .mesh_address import (
     mesh_local_prefix_from_own_address, mesh_local_prefix_from_mlprefix,
     is_valid_mesh_address, build_rloc_address, extract_short_address,
-    is_short_address_derived,
+    is_short_address_derived, format_mesh_address,
 )
 from .relay import RelayedMobiusDevice
 from .device import (
     MobiusDevice, MobiusPump, LightIntensityResult, LightPollResult, FullPollResult,
+    schedule_capacity, min_schedule_capacity, tank_group,
     SERVICE_GENERAL, CHAR_RX_DATA, CHAR_RX_FINAL, CHAR_TX_DATA, CHAR_TX_FINAL,
 )
 from .discovery import (
@@ -82,7 +82,7 @@ from .mob import (
     MAX_PUMP_PRIMITIVE_SIZE,
 )
 
-__version__ = "0.8.3"
+__version__ = "0.9.0"
 
 __all__ = [
     "__version__",
@@ -98,9 +98,10 @@ __all__ = [
     "OPCODE_GET_ATTR_ELEMENTS", "OPCODE_GET_ATTR_ELEMENTS_EXT", "OPCODE_GET_OPCODES",
     # constants
     "PrimitiveType", "PRIMITIVE_SIZE", "LIGHT_PRIMITIVES",
-    "PUMP_PRIMITIVES_VERIFIED", "PUMP_PRIMITIVES_EXPERIMENTAL",
+    "PUMP_PRIMITIVES_VERIFIED", "PUMP_PRIMITIVES_EXPERIMENTAL", "PUMP_PRIMITIVES", "enum_or_none",
+    "primitive_type_from_name", "support_tier", "PumpParamRange", "pump_param_range", "pump_param_errors",
     "Model", "MODEL_MANUFACTURER", "manufacturer_for_model",
-    "ErrorState", "C2Attribute", "PhysicalValueID", "VisualID",
+    "ErrorState", "C2Attribute", "OperationMode", "PhysicalValueID", "VisualID",
     "SceneID", "OperationState", "FsciStatus",
     "PumpMode", "PumpOverrideMode", "RampType", "PumpParam", "PUMP_PARAM_SIZE", "PUMP_MODE_PARAMS",
     "supported_pump_modes",
@@ -112,12 +113,12 @@ __all__ = [
     "LightPrimitive", "SchedulePoint", "interpolate_light_schedule",
     "PumpPrimitiveValue", "PumpSchedulePoint", "get_active_pump_block",
     "light_schedule_to_dict", "light_schedule_from_dict",
-    "pump_schedule_to_dict", "pump_schedule_from_dict",
+    "pump_schedule_to_dict", "pump_schedule_from_dict", "pump_params_to_dict",
     "MAX_PUMP_SCHEDULE_POINT_SIZE",
     # scenes
     "Scene", "ActiveScene", "decode_configured_scenes", "decode_active_scene",
     # manufacturer
-    "MOBIUS_COMPANY_ID_ECOTECH", "MOBIUS_COMPANY_ID_AQUAILLUMINATION", "MOBIUS_COMPANY_IDS", "MobiusAdvertisement", "parse_manufacturer_data",
+    "MOBIUS_COMPANY_ID_ECOTECH", "MOBIUS_COMPANY_ID_AQUAILLUMINATION", "MOBIUS_COMPANY_IDS", "MobiusAdvertisement", "parse_manufacturer_data", "parse_advertisement",
     # modifiers
     "AcclimationInfo", "is_night_segment",
     "julian_day_from_date", "lunar_days_into_phase", "lunar_percent_reduction",
@@ -133,9 +134,11 @@ __all__ = [
     "next_coap_token",
     "mesh_local_prefix_from_own_address", "mesh_local_prefix_from_mlprefix", "is_valid_mesh_address",
     "build_rloc_address", "extract_short_address", "is_short_address_derived",
+    "format_mesh_address",
     "RelayedMobiusDevice",
     # device
     "MobiusDevice", "MobiusPump", "LightIntensityResult", "LightPollResult", "FullPollResult",
+    "schedule_capacity", "min_schedule_capacity", "tank_group",
     "SERVICE_GENERAL", "CHAR_RX_DATA", "CHAR_RX_FINAL", "CHAR_TX_DATA", "CHAR_TX_FINAL",
     # discovery
     "scan_for_mobius_devices", "scan_for_mobius_devices_with_info", "group_by_pan_id",