Module smartapp.api.smartthings.devices

Classes

class Device (token=None, session=None)

class: api.Device

Perform requests to the SmartThings device API. This is intended to provide a fairly low level set of methods to the API functionality providing the serialization of the corresponding OpenAPI models, rather than an 'ORM-like' interface.

Expand source code

class Device(http.RESTClient):
    """class: api.Device

    Perform requests to the SmartThings device API.  This is intended
    to provide a fairly low level set of methods to the API functionality
    providing the serialization of the corresponding OpenAPI models, rather
    than an 'ORM-like' interface.
    """

    def __init__(self, token=None, session=None):
        api = self.__class__.config.get('api')
        super().__init__(api['host'], api['base'], RESOURCE, token=token, session=session)

    async def list(self):
        """Yields a device generator, despite the function being
        async, the generator returned is not so we are blocking
        for the full response.

        Yields:
            smartapp.api.models.DeviceCollection
        """
        for item in models.DeviceCollection.construct(
            **await self.do('GET', '/')
        ).items:
            yield item

    async def create(self, app_id, location_id, profile_id, label):
        """Use the SmartApp auth to create a device, with itself as
        the owner.

        Args:
            app_id (str): InstalledAppId
            location_id (str): LocationID
            profile_id (str): ProfileID
            label (str): Device Label

        Returns:
            smartapp.api.models.smartthings.Device
        """
        return models.smartthings.Device.parse_obj(
            await self.do('POST', '/',
                models.smartthings.DeviceInstallRequest(
                    app=models.smartthings.App(
                        profileId=profile_id,
                        installedAppId=app_id
                    ),
                    locationId=location_id,
                    label=label
                ).dict()
            )
        )

    async def event(self, device_api_id, event):
        """Send an event for a device to the device event endpoint.
        Uses SmartApp auth which must also be the device owner.

        Args:
            device_id (str): SmartThings DeviceID
            event (DeviceEventRequest): Device Event model

        Returns:
            dict
        """
        path = '/{}/events'.format(device_api_id)
        return await self.do('POST', path,
            models.smartthings.DeviceEventsRequest(
                deviceEvents=[
                    models.smartthings.DeviceStateEvent.parse_obj(event)
                ]
            ).dict()
         )

    async def update(self, device_api_id, update):
        """Update a device entry

        Args:
            device_api_id (str): DeviceID
            update (str): UpdateDeviceRequest

        Return:
            smartapp.api.models.smartthings.Device
        """
        return models.smartthings.Device.parse_obj(
            await self.do('PUT', '/{}'.format(device_api_id),
                models.smartthings.UpdateDeviceRequest.parse_obj(
                    update
                ).dict()
            )
        )

Ancestors

• smartapp.api.http.RESTClient

Methods

async def create(self, app_id, location_id, profile_id, label)

Use the SmartApp auth to create a device, with itself as the owner.

Args

app_id : str

InstalledAppId

location_id : str

LocationID

profile_id : str

ProfileID

label : str

Device Label

Returns

smartapp.api.models.smartthings.Device

Expand source code

async def create(self, app_id, location_id, profile_id, label):
    """Use the SmartApp auth to create a device, with itself as
    the owner.

    Args:
        app_id (str): InstalledAppId
        location_id (str): LocationID
        profile_id (str): ProfileID
        label (str): Device Label

    Returns:
        smartapp.api.models.smartthings.Device
    """
    return models.smartthings.Device.parse_obj(
        await self.do('POST', '/',
            models.smartthings.DeviceInstallRequest(
                app=models.smartthings.App(
                    profileId=profile_id,
                    installedAppId=app_id
                ),
                locationId=location_id,
                label=label
            ).dict()
        )
    )

async def event(self, device_api_id, event)

Send an event for a device to the device event endpoint. Uses SmartApp auth which must also be the device owner.

Args

device_id : str

SmartThings DeviceID

event : DeviceEventRequest

Device Event model

Returns

dict

Expand source code

async def event(self, device_api_id, event):
    """Send an event for a device to the device event endpoint.
    Uses SmartApp auth which must also be the device owner.

    Args:
        device_id (str): SmartThings DeviceID
        event (DeviceEventRequest): Device Event model

    Returns:
        dict
    """
    path = '/{}/events'.format(device_api_id)
    return await self.do('POST', path,
        models.smartthings.DeviceEventsRequest(
            deviceEvents=[
                models.smartthings.DeviceStateEvent.parse_obj(event)
            ]
        ).dict()
     )

async def list(self)

Yields a device generator, despite the function being async, the generator returned is not so we are blocking for the full response.

Yields

smartapp.api.models.DeviceCollection

Expand source code

async def list(self):
    """Yields a device generator, despite the function being
    async, the generator returned is not so we are blocking
    for the full response.

    Yields:
        smartapp.api.models.DeviceCollection
    """
    for item in models.DeviceCollection.construct(
        **await self.do('GET', '/')
    ).items:
        yield item

async def update(self, device_api_id, update)

Update a device entry

Args

device_api_id : str

DeviceID

update : str

UpdateDeviceRequest

Return

smartapp.api.models.smartthings.Device

Expand source code

async def update(self, device_api_id, update):
    """Update a device entry

    Args:
        device_api_id (str): DeviceID
        update (str): UpdateDeviceRequest

    Return:
        smartapp.api.models.smartthings.Device
    """
    return models.smartthings.Device.parse_obj(
        await self.do('PUT', '/{}'.format(device_api_id),
            models.smartthings.UpdateDeviceRequest.parse_obj(
                update
            ).dict()
        )
    )