Welcome to Python Kodak Smart Home’s documentation!¶

kodaksmarthome package¶

Submodules¶

kodaksmarthome.api module¶

class kodaksmarthome.api.KodakSmartHome(username, password, region='EU')[source]¶

Bases: object

Kodak Smart Home API session.

Provides connection to Kodak Smart Home portal.

Parameters

username (str) – username registered in Kodak Smart Home Portal
password (str) – password registered in Kodak Smart Home Portal
region (str) – Global Region Portal. Options: ‘EU’. Default: ‘EU’

connect()[source]¶

Connect to Kodak Smart Home Portal and get all information needed.

Returns: None
Exception: ConnectionError

disconnect()[source]¶

Disconnect from Kodak Smart Portal

Returns: None
Exception: ConnectionError

get_battery_events(device_id=None)[source]¶

List all battery devices events from specific device, sorted by creation date.

Returns: list of battery devices events
Exception: ConnectionError
Return type: list

property get_devices¶

List all registered devices in Kodak Smart Portal and its details.

Returns: all devices and information
Exception: ConnectionError
Return type: list

property get_events¶

Get all devices events

Returns: list of devices events
Exception: ConnectionError
Return type: list

get_events_device(device_id=None)[source]¶

Get all device events

Parameters: device_id (str) – device id available in the device information KodakSmartHome.get_devices
Returns: list events
Return type: list

get_motion_events(device_id=None)[source]¶

List all motion devices events from specific device sorted by creation date.

Returns: list of motion devices events
Exception: ConnectionError
Return type: list

get_sound_events(device_id=None)[source]¶

List all sound devices events from specific device sorted by creation date.

Returns: list of sound devices events
Exception: ConnectionError
Return type: list

update()[source]¶

Update the device list and events data

Returns: True
Return type: bool
Exception: ConnectionError

kodaksmarthome.constants module¶

Module contents¶

https://travis-ci.org/kairoaraujo/python-kodaksmarthome.svg?branch=master

https://readthedocs.org/projects/python-kodaksmarthome/badge/?version=latest

Python Kodak Smart Home¶

Python Kodak Smart Home is a library written in Python 3 (>=3.7) that works as API for [Kodak Smart Home Portal](https://kodaksmarthome.com).

This API uses the credentials from Kodak Smart Home Portal to fetch devices registered and its events to be used as Python Projects.

*This project is not part of Kodak.*

Installation¶

pip install python-kodaksmarthome

Usage¶

Initializing the connection¶

>>> from kodaksmarthome import KodakSmartHome
>>> my_home = KodakSmartHome('my@email.com', 'my-pass')
>>> my_home.connect()
>>> my_home.is_connected
True

Listing devices, state, model and device id¶

>>> for device in my_home.get_devices:
...   print(f"Device: {device['name']}")
...   print(f"Device ID: {device['device_id']})
...   print(f"Model: {device['model_name']})
...   print(f"Online: {device['is_online']}\n")
...
Device: Playground
Device ID: '000009999999999999999999'
Model: Cherish 525
Online: False

Device: Bedroom
Device ID: '00000222222222222222222'
Model: Cherish 525
Online: True

Getting last device motion events and some details¶

>>> motion_events = my_home.get_motion_events(device_id="00000222222222222222222")
>>> for event in motion_events[:2]:
...    print(f"snapshot: {event['snapshot']}")
...    print(f"video_recorded: {event['data'][0]['file']}")
...    print(f"data: {event['created_date']}\n")

snapshot: http://video_url/00000222222222222222222/SNAPSHOT.jpg
video_recorded: http://video_url/00000222222222222222222/VIDEO000001.flv
date: 2020-01-04T16:11:48.000Z

snapshot: http://video_url/00000222222222222222222/SNAPSHOT
video_recorded: http://video_url/00000222222222222222222/VIDEO000002.flv
date: 2020-01-04T16:08:52.000Z