Metadata-Version: 2.1
Name: hubspace
Version: 1.0.0
Author-email: Leyla Becker <git@jan-leila.com>
License: Copyright © 2022 Leyla Becker
        
        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.
Project-URL: Homepage, https://github.com/jan-leila/hubspace-py
Keywords: hubspace,iot
Description-Content-Type: text/markdown
License-File: LICENSE

# hubspace-py

tools for intergrading with hubspace though python

### installing:
`pip install hubspace`

### getting started:

```py
from hubspace import Hubspace

hubspace = Hubspace(username, password)
```

### examples:

```py
# get json info for all devices
hubspace.getDeviceInfo()
# get array of all device objects
devices = hubspace.getDevices()
# get target device object
device = hubspace.getDevice(deviceID)

# get additional information about devices
states = hubspace.getDeviceStates()
tags = hubspace.getDeviceTags()
attributes = hubspace.getDeviceAttributes()

# get all data for all devices
self.getDevices(["state", "tags", "attributes"])

# get device metadata
hubspace.getMetadata()
# get conclave access information
hubspace.getConclaveAccess()

# get the id of this device
device.getID()
# get the hubspace that created this device
device.getHubspace()
# get the info for this device
device.getInfo()
# get additional information about this device
device.getState()
device.getTags()
device.getAttributes()
# get metadata for this device
device.getMetadata()
# get the name of this device
device.getName()
# set the name of this device
device.setName()
# get the default name for this device
device.getDefaultName()
# get the name of the manufacturer of this device
device.getManufacturerName()
# get the model number for this device
device.getModel()
# get the class of the device (ie. light, fan ...etc)
device.getDeviceClass()
# read an action type for this device (see getgetAttributes for action info)
device.readAction(actionID)
# write action data for this device
device.writeAction(actionID, actionData)
```
