Powered by Redocly

/config/local/sensor/{name}/channel

The A/D converter channel configuration of the named sensor.

Get /config/local/sensor/{name}/channel

SecurityApiKey
Request
path Parameters
name
required
string

The name of a sensor (L1-L3, Ldc, or S1-S30).

Example: S1
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/local/sensor/{name}/channel
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/local/sensor/{name}/channel
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a sensor (L1-L3, Ldc, or S1-S30).


 
 Example:  S1
Request Body schema: application/json
bias
number (configLocalSensorNameChannelBias) 
The bias value (offset) to be added when converting an A/D
converter sample to a physical quantity.


 
mode
string (configLocalSensorNameChannelMode) 
The channel's acquisition mode.  Possible values are:


    

  • integrate: The sample values are integrated over time.
    

    • 

  • normal: The sensor is operating in normal mode.
    

    • 

  • off: The sensor is not in use.
    

    • 



 Enum: "off" "normal" "integrate"  
scale
number (configLocalSensorNameChannelScale) 
The scale value by which an A/D converter sample is to be
divided to convert a sample to a physical quantity (the bias
value is added to the sample before the scale is applied).


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/local/sensor/{name}/channel
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/local/sensor/{name}/channel
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a sensor (L1-L3, Ldc, or S1-S30).


 
 Example:  S1
Request Body schema: application/json
bias
number (configLocalSensorNameChannelBias) 
The bias value (offset) to be added when converting an A/D
converter sample to a physical quantity.


 
mode
string (configLocalSensorNameChannelMode) 
The channel's acquisition mode.  Possible values are:


    

  • integrate: The sample values are integrated over time.
    

    • 

  • normal: The sensor is operating in normal mode.
    

    • 

  • off: The sensor is not in use.
    

    • 



 Enum: "off" "normal" "integrate"  
scale
number (configLocalSensorNameChannelScale) 
The scale value by which an A/D converter sample is to be
divided to convert a sample to a physical quantity (the bias
value is added to the sample before the scale is applied).


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/local/sensor/{name}/channel
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/local/sensor/{name}/channel
Reset channel to default configuration.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a sensor (L1-L3, Ldc, or S1-S30).


 
 Example:  S1
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/local/sensor/{name}/channel
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/local/sensor/{name}/channel/bias