ExVcom.Api.Default (ex_vcom v0.1.1)
API calls for all endpoints tagged Default.
Link to this section Summary
Functions
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- form_id (integer()):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- o_auth_login (OAuthLogin):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- abbreviation_id (String.t):
- from (DateTime.t): Start date
- to (DateTime.t): End date
- resolution (String.t): Defaults to
day. - opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The option minute resolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher) The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- resolution (String.t): Defaults to
interval. - opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Depending on your contract type different kinds of forecasts are provided. | Category | Description | |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Day-Ahead | Only day-ahead forecasts can be retrieved. The first timestamp starts at 00:00:00 of the following day. They are based on numerical weather prediction and will update a couple times per day. | | Intraday | Both day-ahead and intraday forecasts can be retrieved. They are also based on numerical weather prediction and will update a couple times per day. | | Intraday Optimized | Both day-ahead and intraday forecasts can be retrieved. Satellite based forecasts are combined with numerical weather prediction. The forecasts are updated every 15 minutes. |
The resolution fixed to month at current moment.
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Get single user information by its username
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to.
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to.
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
The maximum time span is 24 hours between from and to.
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- user_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
If no time range is given the endpoint returns the latest reading.
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Returns all tickets.
Create a ticket
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- attachment_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Get all attachments
Create an attachment Please note there’s a limit of 5 attachments per ticket.
Delete a comment
Get single comment
Update a comment
Get all comments
Create a comment
Delete a ticket
Returns detailed information about a single ticket.
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Link to this section Functions
cmms_systems_get(connection, opts \\ [])
@spec cmms_systems_get( Tesla.Env.client(), keyword() ) :: {:ok, ExVcom.Model.SystemsResponse.t()} | {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
cmms_workorders_get(connection, opts \\ [])
@spec cmms_workorders_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.CmmsWorkordersResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
cmms_workorders_workorder_id_forms_form_id_get(connection, workorder_id, form_id, opts \\ [])
@spec cmms_workorders_workorder_id_forms_form_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.CmmsWorkorderFormResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- form_id (integer()):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
cmms_workorders_workorder_id_forms_get(connection, workorder_id, opts \\ [])
@spec cmms_workorders_workorder_id_forms_get(Tesla.Env.client(), integer(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.CmmsWorkorderFormsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
cmms_workorders_workorder_id_get(connection, workorder_id, opts \\ [])
@spec cmms_workorders_workorder_id_get(Tesla.Env.client(), integer(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.CmmsWorkorderResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- workorder_id (integer()):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
login_post(connection, o_auth_login, opts \\ [])
@spec login_post(Tesla.Env.client(), ExVcom.Model.OAuthLogin.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.OAuthCredentials.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- o_auth_login (OAuthLogin):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
session_get(connection, opts \\ [])
@spec session_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SessionResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_abbreviations_abbreviation_id_measurement_get(connection, abbreviation_id, from, to, resolution, opts \\ [])
@spec systems_abbreviations_abbreviation_id_measurement_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SystemMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- abbreviation_id (String.t):
- from (DateTime.t): Start date
- to (DateTime.t): End date
- resolution (String.t): Defaults to
day. - opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_abbreviations_get(connection, opts \\ [])
@spec systems_abbreviations_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SystemsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_get(connection, opts \\ [])
@spec systems_get( Tesla.Env.client(), keyword() ) :: {:ok, ExVcom.Model.SystemsResponse.t()} | {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_basics_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, opts \\ [])
@spec systems_system_key_basics_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_basics_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, opts \\ [])
@spec systems_system_key_basics_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.MeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_basics_abbreviations_get(connection, system_key, opts \\ [])
@spec systems_system_key_basics_abbreviations_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_basics_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_basics_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to 0
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_batteries_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher). - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_batteries_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_batteries_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher).
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_batteries_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_batteries_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.BatteryResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_batteries_get(connection, system_key, opts \\ [])
@spec systems_system_key_batteries_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.BulkMeasurementResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The option minute resolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher) The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :resolution (String.t): Defaults to
interval. - :device_ids (String.t): Comma separated deviceIds
- :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to 0
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_calculations_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, opts \\ [])
@spec systems_system_key_calculations_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_calculations_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, opts \\ [])
@spec systems_system_key_calculations_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.MeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_calculations_abbreviations_get(connection, system_key, opts \\ [])
@spec systems_system_key_calculations_abbreviations_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_calculations_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_calculations_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to 0
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_calculations_simulation_get(connection, system_key, from, to, resolution, opts \\ [])
@spec systems_system_key_calculations_simulation_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SimulationValueResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- resolution (String.t): Defaults to
interval. - opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_forecasts_forecast_get(connection, system_key, opts \\ [])
@spec systems_system_key_forecasts_forecast_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.ForecastResponse.t()} | {:error, Tesla.Env.t()}
Depending on your contract type different kinds of forecasts are provided. | Category | Description | |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Day-Ahead | Only day-ahead forecasts can be retrieved. The first timestamp starts at 00:00:00 of the following day. They are based on numerical weather prediction and will update a couple times per day. | | Intraday | Both day-ahead and intraday forecasts can be retrieved. They are also based on numerical weather prediction and will update a couple times per day. | | Intraday Optimized | Both day-ahead and intraday forecasts can be retrieved. Satellite based forecasts are combined with numerical weather prediction. The forecasts are updated every 15 minutes. |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
- :hours_into_future (integer()): Between 1 and 96. Defaults to 48.
- :format (String.t): Defaults to
json. - :resolution (String.t): Defaults to
fifteen-minutes. - :timezone (String.t): Defaults to system timezone
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_forecasts_yield_specific_energy_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_forecasts_yield_specific_energy_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.MeasurementValueResponse.t()} | {:error, Tesla.Env.t()}
The resolution fixed to month at current moment.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_get(connection, system_key, opts \\ [])
@spec systems_system_key_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.SystemResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_inverters_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher). - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_inverters_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_inverters_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_inverters_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_inverters_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.VirtualMeterDetailsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_inverters_get(connection, system_key, opts \\ [])
@spec systems_system_key_inverters_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.InverterResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_meters_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher). - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_meters_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_meters_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_meters_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_meters_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.MeterResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_meters_get(connection, system_key, opts \\ [])
@spec systems_system_key_meters_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_picture_get(connection, system_key, opts \\ [])
@spec systems_system_key_picture_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.PictureResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
- :username (String.t): Get single user information by its username
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_power_plant_controllers_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher). - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_power_plant_controllers_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_power_plant_controllers_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher).
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_power_plant_controllers_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_power_plant_controllers_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.PowerPlantControllerResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_power_plant_controllers_get(connection, system_key, opts \\ [])
@spec systems_system_key_power_plant_controllers_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_responsibilities_get(connection, system_key, opts \\ [])
@spec systems_system_key_responsibilities_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.ResponsibilitiesResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_sensors_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher) - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_sensors_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_sensors_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span between from and to varies depending on the resolution as listed below. | Resolution | Maximum time span | |-----------------|-------------------| | minute | 1 day | | interval | 31 days | | fifteen-minutes | 31 days | | thirty-minutes | 31 days | | hour | 31 days | | day | 60 days | | month | 1 year | | year | no limitation |
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_sensors_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_sensors_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SensorResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_sensors_get(connection, system_key, opts \\ [])
@spec systems_system_key_sensors_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_statuses_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_statuses_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_statuses_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_statuses_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_statuses_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.StatusResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_statuses_get(connection, system_key, opts \\ [])
@spec systems_system_key_statuses_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_stringboxes_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher). - :device_ids (String.t): Comma separated deviceIds
- :active_only (integer()): Export active strings only, defaults to
0.
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_stringboxes_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_stringboxes_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_stringboxes_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_stringboxes_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.StringboxResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_stringboxes_get(connection, system_key, opts \\ [])
@spec systems_system_key_stringboxes_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_technical_data_get(connection, system_key, opts \\ [])
@spec systems_system_key_technical_data_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.TechnicalDataResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_bulk_measurements_get(connection, system_key, from, to, opts \\ [])
@spec systems_system_key_trackers_bulk_measurements_get( Tesla.Env.client(), String.t(), DateTime.t(), DateTime.t(), keyword() ) :: {:ok, nil} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to. The following query parameters are valid only if format is csv: - delimiter: commaǀsemicolonǀcolonǀtab The delimiter, defaults to comma - lineBreak: LFǀCRǀCR/LF The line breaks, defaults to LF - decimalPoint: dotǀcomma The decimal point, defaults to dot - emptyPlaceholder: empty string by default, any text accepted The place holder for empty value - precision: accepts from 0 to 4 The decimal precision, defaults to 2
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- from (DateTime.t):
- to (DateTime.t):
- opts (KeywordList): [optional] Optional parameters
- :format (String.t): Export format, defaults to
json - :abbreviations (String.t): Comma separated abbreviations
- :include_interval (integer()): Defaults to
0. Only forintervalresolution. - :resolution (String.t): Defaults to
interval. The optionminuteresolution is only supported by meteocontrol blue'Log XM / XC (Firmware 2.0 and higher) - :device_ids (String.t): Comma separated deviceIds
- :format (String.t): Export format, defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_device_id_abbreviations_abbreviation_id_get(connection, system_key, abbreviation_id, device_id, opts \\ [])
@spec systems_system_key_trackers_device_id_abbreviations_abbreviation_id_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_device_id_abbreviations_abbreviation_id_measurements_get(connection, system_key, abbreviation_id, from, to, device_id, opts \\ [])
@spec systems_system_key_trackers_device_id_abbreviations_abbreviation_id_measurements_get( Tesla.Env.client(), String.t(), String.t(), DateTime.t(), DateTime.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceMeasurementsAbbreviationsResponse.t()} | {:error, Tesla.Env.t()}
The maximum time span is 24 hours between from and to.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- abbreviation_id (String.t):
- from (DateTime.t):
- to (DateTime.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :include_interval (integer()): Defaults to
0. - :resolution (String.t): Defaults to
interval.
- :include_interval (integer()): Defaults to
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_device_id_abbreviations_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_trackers_device_id_abbreviations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.AbbreviationResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_trackers_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.SensorResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_trackers_get(connection, system_key, opts \\ [])
@spec systems_system_key_trackers_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_users_get(connection, system_key, opts \\ [])
@spec systems_system_key_users_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.UserResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_users_user_id_get(connection, system_key, user_id, opts \\ [])
@spec systems_system_key_users_user_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.UserDetailsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- user_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_virtual_meters_device_id_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_virtual_meters_device_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.VirtualMeterDetailsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_virtual_meters_device_id_readings_get(connection, system_key, device_id, opts \\ [])
@spec systems_system_key_virtual_meters_device_id_readings_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.VirtualMeterReadingResponse.t()} | {:error, Tesla.Env.t()}
If no time range is given the endpoint returns the latest reading.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- device_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :from (DateTime.t):
- :to (DateTime.t):
- :type (String.t): Defaults to
all.
returns
Returns
on success {:error, Tesla.Env.t} on failure
systems_system_key_virtual_meters_get(connection, system_key, opts \\ [])
@spec systems_system_key_virtual_meters_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.DeviceResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- system_key (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_causes_get(connection, opts \\ [])
@spec tickets_causes_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.TicketCausesResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_get(connection, opts \\ [])
@spec tickets_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.TicketsResponse.t()} | {:error, Tesla.Env.t()}
Returns all tickets.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :last_changed_at_left_square_bracketfrom_right_square_bracket (DateTime.t):
- :last_changed_at_left_square_bracketto_right_square_bracket (DateTime.t):
- :created_at_left_square_bracketfrom_right_square_bracket (DateTime.t):
- :created_at_left_square_bracketto_right_square_bracket (DateTime.t):
- :rectified_at_left_square_bracketfrom_right_square_bracket (DateTime.t):
- :rectified_at_left_square_bracketto_right_square_bracket (DateTime.t):
- :include_in_reports (String.t): Can contain comma delimited report types
- :status (String.t):
- :severity (String.t): Can contain comma delimited severity types
- :priority (String.t): Can contain comma delimited priority types
- :assignee (String.t): The username of the person being assigned to the ticket, it can contain comma delimited names.
- :system_key (String.t): can contain comma delimited system keys
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_post(connection, ticket_update_payload, opts \\ [])
@spec tickets_post( Tesla.Env.client(), ExVcom.Model.TicketUpdatePayload.t(), keyword() ) :: {:ok, ExVcom.Model.TicketCreateResponse.t()} | {:error, Tesla.Env.t()}
Create a ticket
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_update_payload (TicketUpdatePayload):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_attachments_attachment_id_get(connection, ticket_id, attachment_id, opts \\ [])
@spec tickets_ticket_id_attachments_attachment_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.TicketAttachmentDetailsResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- attachment_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_attachments_get(connection, ticket_id, opts \\ [])
@spec tickets_ticket_id_attachments_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.TicketAttachmentsResponse.t()} | {:error, Tesla.Env.t()}
Get all attachments
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_attachments_post(connection, ticket_id, ticket_attachment_create_payload, opts \\ [])
@spec tickets_ticket_id_attachments_post( Tesla.Env.client(), String.t(), ExVcom.Model.TicketAttachmentCreatePayload.t(), keyword() ) :: {:ok, ExVcom.Model.TicketAttachmentCreateResponse.t()} | {:error, Tesla.Env.t()}
Create an attachment Please note there’s a limit of 5 attachments per ticket.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- ticket_attachment_create_payload (TicketAttachmentCreatePayload):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_comments_comment_id_delete(connection, ticket_id, comment_id, opts \\ [])
@spec tickets_ticket_id_comments_comment_id_delete( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a comment
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- comment_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_comments_comment_id_get(connection, ticket_id, comment_id, opts \\ [])
@spec tickets_ticket_id_comments_comment_id_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:ok, ExVcom.Model.TicketCommentResponse.t()} | {:error, Tesla.Env.t()}
Get single comment
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- comment_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_comments_comment_id_patch(connection, ticket_id, comment_id, ticket_comment_create_payload, opts \\ [])
@spec tickets_ticket_id_comments_comment_id_patch( Tesla.Env.client(), String.t(), String.t(), ExVcom.Model.TicketCommentCreatePayload.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Update a comment
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- comment_id (String.t):
- ticket_comment_create_payload (TicketCommentCreatePayload):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_comments_get(connection, ticket_id, opts \\ [])
@spec tickets_ticket_id_comments_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.TicketCommentsResponse.t()} | {:error, Tesla.Env.t()}
Get all comments
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_comments_post(connection, ticket_id, ticket_comment_create_payload, opts \\ [])
@spec tickets_ticket_id_comments_post( Tesla.Env.client(), String.t(), ExVcom.Model.TicketCommentCreatePayload.t(), keyword() ) :: {:ok, ExVcom.Model.TicketCommentCreateResponse.t()} | {:error, Tesla.Env.t()}
Create a comment
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- ticket_comment_create_payload (TicketCommentCreatePayload):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_delete(connection, ticket_id, opts \\ [])
@spec tickets_ticket_id_delete(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a ticket
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_get(connection, ticket_id, opts \\ [])
@spec tickets_ticket_id_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.TicketResponse.t()} | {:error, Tesla.Env.t()}
Returns detailed information about a single ticket.
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_histories_get(connection, ticket_id, opts \\ [])
@spec tickets_ticket_id_histories_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, ExVcom.Model.TicketHistoryResponse.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
tickets_ticket_id_patch(connection, ticket_id, ticket_update_payload, opts \\ [])
@spec tickets_ticket_id_patch( Tesla.Env.client(), String.t(), ExVcom.Model.TicketUpdatePayload.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Update a ticket
parameters
Parameters
- connection (ExVcom.Connection): Connection to server
- ticket_id (String.t):
- ticket_update_payload (TicketUpdatePayload):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure