seventilation-client

SEC Smart API


Keywords
Swagger, SEC, Smart, API
License
MIT
Install
pip install seventilation-client==0.1.0

Documentation

seventilation-client

This is the API for the SEC Smart System.
<font color="#ff0000">ACHTUNG: Diese API ist noch nicht für den produktiven Einsatz freigegeben!

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 0.1.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import seventilation_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import seventilation_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import seventilation_client
from seventilation_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Returns a device' areas object collection
    api_response = api_instance.devices_id_areas_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_get: %s\n" % e)


# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasLabelBody() # AreasLabelBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Updates the name for the given area
    api_response = api_instance.devices_id_areas_label_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_label_put: %s\n" % e)


# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasModeBody() # AreasModeBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Set a ventilation mode for a given area
    api_response = api_instance.devices_id_areas_mode_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_mode_put: %s\n" % e)


# create an instance of the API class
api_instance = seventilation_client.AreasApi(seventilation_client.ApiClient(configuration))
body = seventilation_client.AreasTimeprogramBody() # AreasTimeprogramBody | 
id = 'id_example' # str | 6-digit-long alphanumerical ID of the device to be adressed

try:
    # Set a timed program for a given area
    api_response = api_instance.devices_id_areas_timeprogram_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AreasApi->devices_id_areas_timeprogram_put: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.sec-smart.app/v1

Class Method HTTP request Description
AreasApi devices_id_areas_get GET /devices/{id}/areas Returns a device' areas object collection
AreasApi devices_id_areas_label_put PUT /devices/{id}/areas/label Updates the name for the given area
AreasApi devices_id_areas_mode_put PUT /devices/{id}/areas/mode Set a ventilation mode for a given area
AreasApi devices_id_areas_timeprogram_put PUT /devices/{id}/areas/timeprogram Set a timed program for a given area
ControllerApi devices_id_controller_get GET /devices/{id}/controller Returns a device' Controller data object
DevicesApi devices_get GET /devices Returns an object array of all your registered devices.
DevicesApi devices_id_get GET /devices/{id} Returns a device object
DevicesApi devices_id_name_put PUT /devices/{id}/name Sets a free choseable name for your device
GatewayApi devices_id_gateway_get GET /devices/{id}/gateway Returns a device' Gateway data object
NotificationsApi devices_id_notifications_get GET /devices/{id}/notifications Returns a device' notification data object
SettingsApi devices_id_settings_device_time_put PUT /devices/{id}/settings/device-time Change the time and date adjustments of your device
SettingsApi devices_id_settings_filter_put PUT /devices/{id}/settings/filter Set a the filter run time and/or perform a filter reset
SettingsApi devices_id_settings_get GET /devices/{id}/settings Returns a device' settings data object
SettingsApi devices_id_settings_sleep_time_put PUT /devices/{id}/settings/sleep-time Set the desired sleep time for sleep time mode
SettingsApi devices_id_settings_summermode_put PUT /devices/{id}/settings/summermode Change the summer ventilation mode.
SettingsApi devices_id_settings_thresholds_put PUT /devices/{id}/settings/thresholds Set the threshold values for humidity and CO² regulation mode
SetupApi devices_id_setup_areas_put PUT /devices/{id}/setup/areas Set up the assignment what kind of boost mode shall be used in the particular areas
SetupApi devices_id_setup_factory_reset_put PUT /devices/{id}/setup/factory-reset Perform a factory reset of the SEC Smart System
SetupApi devices_id_setup_get GET /devices/{id}/setup Returns a device' setup data object
SetupApi devices_id_setup_input_ai_put PUT /devices/{id}/setup/input-ai Set up the configuration for the analog input
SetupApi devices_id_setup_input_di_put PUT /devices/{id}/setup/input-di Set up the configuration for the digital input
SetupApi devices_id_setup_output_do_put PUT /devices/{id}/setup/output-do Set up the configuration for the digital output
SetupApi devices_id_setup_systems_put PUT /devices/{id}/setup/systems Set up the assignment what systems are installed in the particular areas
TelemetryApi devices_id_telemetry_get GET /devices/{id}/telemetry Returns a device' telemetry data object
UsersApi devices_id_users_get GET /devices/{id}/users Returns an array containing the email adresses of all users of this device

Documentation For Models

Documentation For Authorization

myTokenScheme

Author