Merge pull request #1 from kzosabe/basic-implementation

Add basic implementation and README

Author: kzosabe

.gitignore

@@ -1,3 +1,4 @@
-/.venv
-*.pyc
+__pycache__/
+*.py[cod]
+*$py.class
 !.keep

README.md

@@ -1,24 +1,143 @@
 # switchbot-client
 
-[![GitHub Build](https://github.com/kzosabe/switchbot-client/workflows/CI%20Build/badge.svg)](https://github.com/kzosabe/switchbot-client/actions)
-[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-informational?style=flat-square)](README.md#License)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/switchbot-client.svg)](https://pypi.org/project/switchbot-client/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/switchbot-client)](https://pypi.org/project/switchbot-client)
+[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-informational?style=flat-square)](README.md#License)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 
 ## Table of Contents
 
-- [Install](#install)
+- [Authentication](#authentication)
 - [Usage](#usage)
-- [Contributing](#contributing)
 - [License](#license)
 
-## Install
+
+## Authentication
+
+Before you start using this client, you need to get an open token.
+Please follow the instructions in the official documentation below.
+
+https://github.com/OpenWonderLabs/SwitchBotAPI#authentication
+
+Once you have the token, use one of the following methods to pass the information to the client.
+
+### Environment variables
+
+If the environment variable `SWITCHBOT_OPEN_TOKEN` is present, 
+this client will automatically use this value.
+
+```shell
+export SWITCHBOT_OPEN_TOKEN=yourswitchbotopentoken
+python3 your_script_using_switchbot_client.py
+```
+
+```python
+# your_script_using_switchbot_client.py
+client = SwitchBotAPIClient()
+result = client.devices()
+```
+
+### Constructor Arguments
+
+It is also possible to initialize the client by passing a token directly as an argument.
+
+```python
+from switchbot_client import SwitchBotAPIClient
+
+your_token = "yourswitchbotopentoken"
+client = SwitchBotAPIClient(token=your_token)
+result = client.devices()
+```
 
 
 ## Usage
 
+### Get Device List
+
+```python
+from switchbot_client import SwitchBotAPIClient
+
+client = SwitchBotAPIClient()
+result = client.devices()
+print(result.body)
+```
+
+```
+{'deviceList': [{'deviceId': 'ABCDEFG', 'deviceName': 'Meter 0A', 'deviceType': 'Meter', 'enableCloudService': True, 'hubDeviceId': 'ABCDE'}, {'deviceId': 'ABCDE', 'deviceName': 'Hub Mini 0', 'deviceType': 'Hub Mini', 'hubDeviceId': 'ABCDE'}], 'infraredRemoteList': [{'deviceId': '12345', 'deviceName': 'My Light', 'remoteType': 'Light', 'hubDeviceId': 'ABCDE'}, {'deviceId': '12345, 'deviceName': 'My Air Conditioner', 'remoteType': 'Air Conditioner', 'hubDeviceId': 'ABCDE'}]}
+```
+
+If you run the above code, you will get a list of all the devices associated with your SwitchBot account. 
+You can perform operations on the acquired `deviceId`, such as manipulating it or getting its status.
+
+### Get Device Status
+
+```python
+from switchbot_client import SwitchBotAPIClient
+
+client = SwitchBotAPIClient()
+device_id = "YOURDEVICEID"
+print(client.devices_status(device_id))
+```
+
+```
+SwitchBotAPIResponse(status_code=100, message='success', body={'deviceId': 'ABCDE', 'deviceType': 'Meter', 'hubDeviceId': 'ABCDE', 'humidity': 50, 'temperature': 25.0})
+```
+
+This function allows you to get the status of a device.
+Note that only physical devices can be targeted, not virtual infrared remote devices.
+
+Please refer to the following official document to know what kind of information can be obtained from each device.
+
+https://github.com/OpenWonderLabs/SwitchBotAPI#get-device-status
+
+### Control Device
+
+```python
+from switchbot_client import SwitchBotAPIClient, ControlCommand
+
+client = SwitchBotAPIClient()
+device_id = "12345" # My Light(virtual infrared remote devices)
+print(client.devices_control(device_id, ControlCommand.VirtualInfrared.TURN_ON))
+```
+
+```
+SwitchBotAPIResponse(status_code=100, message='success', body={})
+```
+
+It allows you to control the specified device.
+The `ControlCommand` class and the following documents define the commands that can be executed.
+
+https://github.com/OpenWonderLabs/SwitchBotAPI#send-device-control-commands
+
+### Get Scene List
+
+```python
+from switchbot_client import SwitchBotAPIClient
+
+client = SwitchBotAPIClient()
+print(client.scenes())
+```
+
+```
+SwitchBotAPIResponse(status_code=100, message='success', body=[{'sceneId': '12345', 'sceneName': 'My Scene'}])
+```
+
+You can get a list of all the scenes associated with your SwitchBot account.
+
+### Execute Scene
+```python
+from switchbot_client import SwitchBotAPIClient
+
+client = SwitchBotAPIClient()
+print(client.scenes_execute("12345"))
+```
+
+```
+SwitchBotAPIResponse(status_code=100, message='success', body={})
+```
+The specified scene can be executed immediately.
+
 
 ## License
 

poetry.lock

@@ -8,6 +8,7 @@ authors = [
 
 [tool.poetry.dependencies]
 python = "~3.9.6"
+requests = "^2.26.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.1"

pyproject.toml

@@ -0,0 +1,2 @@
+from switchbot_client.client import SwitchBotAPIClient, SwitchBotAPIResponse
+from switchbot_client.enums import ControlCommand