seventilation_client.SetupApi

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

Method	HTTP request	Description
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
devices_id_setup_factory_reset_put	PUT /devices/{id}/setup/factory-reset	Perform a factory reset of the SEC Smart System
devices_id_setup_get	GET /devices/{id}/setup	Returns a device' setup data object
devices_id_setup_input_ai_put	PUT /devices/{id}/setup/input-ai	Set up the configuration for the analog input
devices_id_setup_input_di_put	PUT /devices/{id}/setup/input-di	Set up the configuration for the digital input
devices_id_setup_output_do_put	PUT /devices/{id}/setup/output-do	Set up the configuration for the digital output
devices_id_setup_systems_put	PUT /devices/{id}/setup/systems	Set up the assignment what systems are installed in the particular areas

devices_id_setup_areas_put

object devices_id_setup_areas_put(body, id)

Set up the assignment what kind of boost mode shall be used in the particular areas

Set up the assignment what kind of boost mode shall be used in the particular areas.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Set up the assignment what kind of boost mode shall be used in the particular areas
    api_response = api_instance.devices_id_setup_areas_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_areas_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupAreasBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_factory_reset_put

object devices_id_setup_factory_reset_put(body, id)

Perform a factory reset of the SEC Smart System

Perform a factory reset of the SEC Smart System.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Perform a factory reset of the SEC Smart System
    api_response = api_instance.devices_id_setup_factory_reset_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_factory_reset_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupFactoryresetBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_get

Setup devices_id_setup_get(id)

Returns a device' setup data object

Returns the device subobject setup for the URL-encoded device ID.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Returns a device' setup data object
    api_response = api_instance.devices_id_setup_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

Setup

Authorization

myTokenScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_input_ai_put

object devices_id_setup_input_ai_put(body, id)

Set up the configuration for the analog input

Set up the configuration for the analog input.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Set up the configuration for the analog input
    api_response = api_instance.devices_id_setup_input_ai_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_input_ai_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupInputaiBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_input_di_put

object devices_id_setup_input_di_put(body, id)

Set up the configuration for the digital input

Set up the configuration for the digital input.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Set up the configuration for the digital input
    api_response = api_instance.devices_id_setup_input_di_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_input_di_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupInputdiBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_output_do_put

object devices_id_setup_output_do_put(body, id)

Set up the configuration for the digital output

Set up the configuration for the digital output.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Set up the configuration for the digital output
    api_response = api_instance.devices_id_setup_output_do_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_output_do_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupOutputdoBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

devices_id_setup_systems_put

object devices_id_setup_systems_put(body, id)

Set up the assignment what systems are installed in the particular areas

Set up the assignment what systems are installed in the particular areas.

Example

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

# Configure API key authorization: myTokenScheme
configuration = seventilation_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

try:
    # Set up the assignment what systems are installed in the particular areas
    api_response = api_instance.devices_id_setup_systems_put(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SetupApi->devices_id_setup_systems_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SetupSystemsBody
id	str	6-digit-long alphanumerical ID of the device to be adressed

Return type

object

Authorization

myTokenScheme

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SetupApi.md

Latest commit

History

SetupApi.md

File metadata and controls

seventilation_client.SetupApi

devices_id_setup_areas_put

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_factory_reset_put

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_get

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_input_ai_put

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_input_di_put

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_output_do_put

Example

Parameters

Return type

Authorization

HTTP request headers

devices_id_setup_systems_put

Example

Parameters

Return type

Authorization

HTTP request headers