Release 0.6.8

- Update test dependencies
- Add capabilities and well-known properties and methods for `airConditionerFanMode` and `airFlowDirection` and updated `airConditionerMode` to latest spec
- Add scripts for generating capability and attribute constants from inventory.
- Release under Apache Software License 2.0

Author: andrewsayre

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.pythonPath": ".venv\\Scripts\\python.exe",
+    "[python]": {
+        "editor.rulers": [79]
+    }
+}

LICENSE

@@ -1,21 +1,207 @@
-MIT License
-
-Copyright (c) 2018 Andrew Sayre
-
-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.
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction, and
+    distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by the
+    copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all other
+    entities that control, are controlled by, or are under common control with
+    that entity. For the purposes of this definition, "control" means (i) the
+    power, direct or indirect, to cause the direction or management of such
+    entity, whether by contract or otherwise, or (ii) ownership of
+    fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
+    ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity exercising
+    permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation source,
+    and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical transformation
+    or translation of a Source form, including but not limited to compiled
+    object code, generated documentation, and conversions to
+    other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or Object
+    form, made available under the License, as indicated by a copyright notice
+    that is included in or attached to the work (an example is provided in the
+    Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object form,
+    that is based on (or derived from) the Work and for which the editorial
+    revisions, annotations, elaborations, or other modifications represent,
+    as a whole, an original work of authorship. For the purposes of this
+    License, Derivative Works shall not include works that remain separable
+    from, or merely link (or bind by name) to the interfaces of, the Work and
+    Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including the original
+    version of the Work and any modifications or additions to that Work or
+    Derivative Works thereof, that is intentionally submitted to Licensor for
+    inclusion in the Work by the copyright owner or by an individual or
+    Legal Entity authorized to submit on behalf of the copyright owner.
+    For the purposes of this definition, "submitted" means any form of
+    electronic, verbal, or written communication sent to the Licensor or its
+    representatives, including but not limited to communication on electronic
+    mailing lists, source code control systems, and issue tracking systems
+    that are managed by, or on behalf of, the Licensor for the purpose of
+    discussing and improving the Work, but excluding communication that is
+    conspicuously marked or otherwise designated in writing by the copyright
+    owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity on
+    behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+    Subject to the terms and conditions of this License, each Contributor
+    hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+    royalty-free, irrevocable copyright license to reproduce, prepare
+    Derivative Works of, publicly display, publicly perform, sublicense,
+    and distribute the Work and such Derivative Works in
+    Source or Object form.
+
+3. Grant of Patent License.
+
+    Subject to the terms and conditions of this License, each Contributor
+    hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+    royalty-free, irrevocable (except as stated in this section) patent
+    license to make, have made, use, offer to sell, sell, import, and
+    otherwise transfer the Work, where such license applies only to those
+    patent claims licensable by such Contributor that are necessarily
+    infringed by their Contribution(s) alone or by combination of their
+    Contribution(s) with the Work to which such Contribution(s) was submitted.
+    If You institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+    Contribution incorporated within the Work constitutes direct or
+    contributory patent infringement, then any patent licenses granted to
+    You under this License for that Work shall terminate as of the date such
+    litigation is filed.
+
+4. Redistribution.
+
+    You may reproduce and distribute copies of the Work or Derivative Works
+    thereof in any medium, with or without modifications, and in Source or
+    Object form, provided that You meet the following conditions:
+
+    1. You must give any other recipients of the Work or Derivative Works a
+    copy of this License; and
+
+    2. You must cause any modified files to carry prominent notices stating
+    that You changed the files; and
+
+    3. You must retain, in the Source form of any Derivative Works that You
+    distribute, all copyright, patent, trademark, and attribution notices from
+    the Source form of the Work, excluding those notices that do not pertain
+    to any part of the Derivative Works; and
+
+    4. If the Work includes a "NOTICE" text file as part of its distribution,
+    then any Derivative Works that You distribute must include a readable copy
+    of the attribution notices contained within such NOTICE file, excluding
+    those notices that do not pertain to any part of the Derivative Works,
+    in at least one of the following places: within a NOTICE text file
+    distributed as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or, within a
+    display generated by the Derivative Works, if and wherever such
+    third-party notices normally appear. The contents of the NOTICE file are
+    for informational purposes only and do not modify the License.
+    You may add Your own attribution notices within Derivative Works that You
+    distribute, alongside or as an addendum to the NOTICE text from the Work,
+    provided that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and may
+    provide additional or different license terms and conditions for use,
+    reproduction, or distribution of Your modifications, or for any such
+    Derivative Works as a whole, provided Your use, reproduction, and
+    distribution of the Work otherwise complies with the conditions
+    stated in this License.
+
+5. Submission of Contributions.
+
+    Unless You explicitly state otherwise, any Contribution intentionally
+    submitted for inclusion in the Work by You to the Licensor shall be under
+    the terms and conditions of this License, without any additional
+    terms or conditions. Notwithstanding the above, nothing herein shall
+    supersede or modify the terms of any separate license agreement you may
+    have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+    This License does not grant permission to use the trade names, trademarks,
+    service marks, or product names of the Licensor, except as required for
+    reasonable and customary use in describing the origin of the Work and
+    reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+    Unless required by applicable law or agreed to in writing, Licensor
+    provides the Work (and each Contributor provides its Contributions)
+    on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+    either express or implied, including, without limitation, any warranties
+    or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS
+    FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any risks
+    associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+    In no event and under no legal theory, whether in tort
+    (including negligence), contract, or otherwise, unless required by
+    applicable law (such as deliberate and grossly negligent acts) or agreed
+    to in writing, shall any Contributor be liable to You for damages,
+    including any direct, indirect, special, incidental, or consequential
+    damages of any character arising as a result of this License or out of
+    the use or inability to use the Work (including but not limited to damages
+    for loss of goodwill, work stoppage, computer failure or malfunction,
+    or any and all other commercial damages or losses), even if such
+    Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+    While redistributing the Work or Derivative Works thereof, You may choose
+    to offer, and charge a fee for, acceptance of support, warranty,
+    indemnity, or other liability obligations and/or rights consistent with
+    this License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf of any
+    other Contributor, and only if You agree to indemnify, defend, and hold
+    each Contributor harmless for any liability incurred by, or claims
+    asserted against, such Contributor by reason of your accepting any such
+    warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+    To apply the Apache License to your work, attach the following boilerplate
+    notice, with the fields enclosed by brackets "[]" replaced with your own
+    identifying information. (Don't include the brackets!) The text should be
+    enclosed in the appropriate comment syntax for the file format. We also
+    recommend that a file or class name and description of purpose be included
+    on the same "printed page" as the copyright notice for easier
+    identification within third-party archives.
+
+        Copyright 2018 Andrew N. Sayre
+
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+        or implied. See the License for the specific language governing
+        permissions and limitations under the License.

pysmartthings/capability.py

@@ -7,7 +7,9 @@
 CAPABILITIES_TO_ATTRIBUTES = {
     'accelerationSensor': ['acceleration'],
     'activityLightingMode': ['lightingMode'],
-    'airConditionerMode': ['airConditionerMode'],
+    'airConditionerFanMode': ['fanMode', 'supportedAcFanModes'],
+    'airConditionerMode': ['airConditionerMode', 'supportedAcModes'],
+    'airFlowDirection': ['airFlowDirection'],
     'airQualitySensor': ['airQuality'],
     'alarm': ['alarm'],
     'audioMute': ['mute'],
@@ -107,7 +109,9 @@ class Capability:
 
     acceleration_sensor = 'accelerationSensor'
     activity_lighting_mode = 'activityLightingMode'
+    air_conditioner_fan_mode = 'airConditionerFanMode'
     air_conditioner_mode = 'airConditionerMode'
+    air_flow_direction = 'airFlowDirection'
     air_quality_sensor = 'airQualitySensor'
     alarm = 'alarm'
     audio_mute = 'audioMute'
@@ -191,6 +195,7 @@ class Attribute:
 
     acceleration = 'acceleration'
     air_conditioner_mode = 'airConditionerMode'
+    air_flow_direction = 'airFlowDirection'
     air_quality = 'airQuality'
     alarm = 'alarm'
     battery = 'battery'
@@ -219,6 +224,7 @@ class Attribute:
     energy = 'energy'
     equivalent_carbon_dioxide_measurement = \
         'equivalentCarbonDioxideMeasurement'
+    fan_mode = 'fanMode'
     fan_speed = 'fanSpeed'
     filter_status = 'filterStatus'
     fine_dust_level = 'fineDustLevel'
@@ -274,6 +280,8 @@ class Attribute:
     smoke = 'smoke'
     sound = 'sound'
     st = 'st'
+    supported_ac_fan_modes = 'supportedAcFanModes'
+    supported_ac_modes = 'supportedAcModes'
     supported_button_values = 'supportedButtonValues'
     supported_input_sources = 'supportedInputSources'
     supported_machine_states = 'supportedMachineStates'

pysmartthings/device.py

@@ -42,10 +42,12 @@ class Command:
     override_drlc_action = 'overrideDrlcAction'
     preset_position = 'presetPosition'
     request_drlc_action = 'requestDrlcAction'
+    set_air_flow_direction = 'setAirFlowDirection'
     set_air_conditioner_mode = 'setAirConditionerMode'
     set_color = 'setColor'
     set_color_temperature = 'setColorTemperature'
     set_cooling_setpoint = 'setCoolingSetpoint'
+    set_fan_mode = 'setFanMode'
     set_fan_speed = 'setFanSpeed'
     set_heating_setpoint = 'setHeatingSetpoint'
     set_hue = 'setHue'
@@ -539,6 +541,32 @@ def air_conditioner_mode(self) -> Optional[str]:
         """Get the air conditioner mode attribute."""
         return self._attributes[Attribute.air_conditioner_mode].value
 
+    @property
+    def supported_ac_modes(self) -> Sequence[str]:
+        """Get the supported AC modes attribute."""
+        value = self._attributes[Attribute.supported_ac_modes].value
+        if isinstance(value, Sequence):
+            return sorted(value)
+        return []
+
+    @property
+    def fan_mode(self) -> Optional[str]:
+        """Get the fan mode attribute."""
+        return self._attributes[Attribute.fan_mode].value
+
+    @property
+    def supported_ac_fan_modes(self) -> Sequence[str]:
+        """Get the supported AC fan modes attribute."""
+        value = self._attributes[Attribute.supported_ac_fan_modes].value
+        if isinstance(value, Sequence):
+            return sorted(value)
+        return []
+
+    @property
+    def air_flow_direction(self) -> str:
+        """Get the airFlowDirection attribute."""
+        return self._attributes[Attribute.air_flow_direction].value
+
     @property
     def three_axis(self) -> Optional[Tuple[int, int, int]]:
         """Get the three axis attribute."""
@@ -933,6 +961,28 @@ async def set_air_conditioner_mode(
                 Attribute.air_conditioner_mode, mode)
         return result
 
+    async def set_fan_mode(self, mode: str, *, set_status: bool = False,
+                           component_id: str = 'main'):
+        """Call the setFanMode command."""
+        result = await self.command(
+            component_id, Capability.air_conditioner_fan_mode,
+            Command.set_fan_mode, [mode])
+        if result and set_status:
+            self.status.update_attribute_value(Attribute.fan_mode, mode)
+        return result
+
+    async def set_air_flow_direction(
+            self, direction: str, *, set_status: bool = False,
+            component_id: str = 'main'):
+        """Call the setAirFlowDirection command."""
+        result = await self.command(
+            component_id, Capability.air_flow_direction,
+            Command.set_air_flow_direction, [direction])
+        if result and set_status:
+            self.status.update_attribute_value(
+                Attribute.air_flow_direction, direction)
+        return result
+
     @property
     def status(self):
         """Get the status entity of the device."""

script/generate_attributes.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+"""Generate capabilitiy constants."""
+import re
+import sys
+
+sys.path.append(".")
+from pysmartthings.capability import ATTRIBUTES
+
+
+def main():
+    """Run the script."""
+    attribs = [a for a in ATTRIBUTES]
+    attribs.sort()
+    for a in attribs:
+        print("{} = '{}'".format(re.sub(r'([A-Z])', r'_\1', a).lower(), a))
+
+
+if __name__ == '__main__':
+    sys.exit(main())

script/generate_capabilities.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+"""Generate capabilitiy constants."""
+import re
+import sys
+
+sys.path.append(".")
+from pysmartthings.capability import CAPABILITIES
+
+
+def main():
+    """Run the script."""
+    capabilities = CAPABILITIES.copy()
+    capabilities.sort()
+    for c in capabilities:
+        print("{} = '{}'".format(re.sub(r'([A-Z])', r'_\1', c).lower(), c))
+
+
+if __name__ == '__main__':
+    sys.exit(main())