v0.6.7

- Add Three Axis capability and well-known device attribute.
- Updates `apply_attribute_update` to accept `unit` and `data`

Author: andrewsayre

pysmartthings/capability.py

@@ -84,6 +84,7 @@
     'thermostatMode': ['thermostatMode', 'supportedThermostatModes'],
     'thermostatOperatingState': ['thermostatOperatingState'],
     'thermostatSetpoint': ['thermostatSetpoint'],
+    'threeAxis': ['threeAxis'],
     'tvChannel': ['tvChannel'],
     'tvocMeasurement': ['tvocLevel'],
     'ultravioletIndex': ['ultravioletIndex'],
@@ -173,6 +174,7 @@ class Capability:
     thermostat_mode = 'thermostatMode'
     thermostat_operating_state = 'thermostatOperatingState'
     thermostat_setpoint = 'thermostatSetpoint'
+    three_axis = 'threeAxis'
     tv_channel = 'tvChannel'
     tvoc_measurement = 'tvocMeasurement'
     ultraviolet_index = 'ultravioletIndex'
@@ -286,6 +288,7 @@ class Attribute:
     thermostat_operating_state = 'thermostatOperatingState'
     thermostat_setpoint = 'thermostatSetpoint'
     thermostat_setpoint_range = 'thermostatSetpointRange'
+    three_axis = 'threeAxis'
     tv_channel = 'tvChannel'
     tvoc_level = 'tvocLevel'
     ultraviolet_index = 'ultravioletIndex'

pysmartthings/const.py

@@ -1,4 +1,4 @@
 """Define consts for the pysmartthings package."""
 
 __title__ = "pysmartthings"
-__version__ = "0.6.6"
+__version__ = "0.6.7"

pysmartthings/device.py

@@ -3,7 +3,7 @@
 import colorsys
 from enum import Enum
 import re
-from typing import Any, Dict, Mapping, Optional, Sequence
+from typing import Any, Dict, Mapping, Optional, Sequence, Tuple
 
 from .api import Api
 from .capability import ATTRIBUTE_ON_VALUES, Attribute, Capability
@@ -184,7 +184,7 @@ def is_on(self, attribute: str) -> bool:
             ATTRIBUTE_ON_VALUES[attribute]
 
     def update_attribute_value(self, attribute: str, value):
-        """Update the value of an attribute while mantaining unit and data."""
+        """Update the value of an attribute while maintaining unit and data."""
         status = self._attributes[attribute]
         self._attributes[attribute] = Status(value, status.unit, status.data)
 
@@ -539,6 +539,11 @@ def air_conditioner_mode(self) -> Optional[str]:
         """Get the air conditioner mode attribute."""
         return self._attributes[Attribute.air_conditioner_mode].value
 
+    @property
+    def three_axis(self) -> Optional[Tuple[int, int, int]]:
+        """Get the three axis attribute."""
+        return self._attributes[Attribute.three_axis].value
+
 
 class DeviceStatus(DeviceStatusBase):
     """Define the device status."""
@@ -553,14 +558,18 @@ def __init__(self, api: Api, device_id: str, data=None):
             self.apply_data(data)
 
     def apply_attribute_update(self, component_id: str, capability: str,
-                               attribute: str, value: Any):
+                               attribute: str, value: Any,
+                               unit: Optional[str] = None,
+                               data: Optional[Dict] = None):
         """Apply an update to a specific attribute."""
-        # capability future usage.
-        if component_id == 'main':
-            self.update_attribute_value(attribute, value)
-        elif component_id in self._components.keys():
-            self._components[component_id].update_attribute_value(
-                attribute, value)
+        component = self
+        if component_id != 'main' and component_id in self._components:
+            component = self._components[component_id]
+
+        # preserve unit until fixed in the API
+        old_status = component.attributes[attribute]
+        component.attributes[attribute] = Status(
+            value, unit or old_status.unit, data)
 
     def apply_data(self, data: dict):
         """Apply the values from the given data structure."""

tests/test_device.py

@@ -3,7 +3,8 @@
 import pytest
 
 from pysmartthings.capability import Attribute, Capability
-from pysmartthings.device import Device, DeviceEntity, DeviceStatus, DeviceType
+from pysmartthings.device import (
+    Device, DeviceEntity, DeviceStatus, DeviceType, Status)
 
 from .conftest import DEVICE_ID, LOCATION_ID, ROOM_ID
 from .utilities import get_json
@@ -807,11 +808,30 @@ def test_apply_attribute_update():
         """Tests the apply_attribute_update method."""
         # Arrange
         data = get_json('device_status.json')
-        status = DeviceStatus(None, DEVICE_ID, data)
+        device = DeviceStatus(None, DEVICE_ID, data)
         # Act
-        status.apply_attribute_update('main', 'switchLevel', 'level', 50)
+        device.apply_attribute_update(
+            'main', Capability.switch_level, Attribute.level, 50, '%',
+            {'test': 'test'})
         # Assert
-        assert status.level == 50
+        status = device.attributes[Attribute.level]
+        assert status.value == 50
+        assert status.unit == '%'
+        assert status.data == {'test': 'test'}
+
+    @staticmethod
+    def test_apply_attribute_update_preserve_unit():
+        """Tests the apply_attribute_update preserves the old unit."""
+        # Arrange
+        data = get_json('device_status.json')
+        device = DeviceStatus(None, DEVICE_ID, data)
+        device.attributes[Capability.switch_level] = Status(40, '%', None)
+        # Act
+        device.apply_attribute_update(
+            'main', Capability.switch_level, Attribute.level, 50)
+        # Assert
+        status = device.attributes[Attribute.level]
+        assert status.unit == '%'
 
     @staticmethod
     def test_apply_attribute_update_child_status():
@@ -1007,6 +1027,7 @@ def test_well_known_attributes():
         status.update_attribute_value(Attribute.door, 'open')
         status.update_attribute_value(Attribute.window_shade, 'closed')
         status.update_attribute_value(Attribute.data, {'test': 'test'})
+        status.update_attribute_value(Attribute.three_axis, [0, 0, 0])
         # Act/Assert
         assert status.humidity == 50
         assert status.temperature == 55
@@ -1017,6 +1038,7 @@ def test_well_known_attributes():
         assert status.door == 'open'
         assert status.window_shade == 'closed'
         assert status.data == {'test': 'test'}
+        assert status.three_axis == [0, 0, 0]
 
     @staticmethod
     def test_well_known_ocf_attributes():