Powered by Redocly

/config/local/sensor/{name}

The sensor configuration.

Get /config/local/sensor/{name}

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}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/local/sensor/{name}
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
object (configLocalSensorNameChannel) 
The A/D converter channel configuration of the named sensor.


 
error
number (configLocalSensorNameError) 
The attached sensor's relative output error (ratio error) in
percent. For example, a value of 2.5 would indicate that the
sensor is reading 2.5% higher than nominal. This value is ignored
if member model is CTid.


 
model
string (configLocalSensorNameModel) 
The model name of the attached sensor. If this is CTid, a
CTid®-enabled sensor is attached and the /ctid
service should be used to obtain details about the attached
sensor.


 
phase
string (configLocalSensorNamePhase) 
The phase (timing) adjustment required by the attached sensor.
This value is ignored if member model is CTid.


The format of this string is a colon-separated list of phase- and
amplitude-level pairs of the form p@l, where p is the
phase-adjustment in degrees at 60Hz, and l is a percentage of
the sensor's full scale value.  For example, for a 100A current
sensor, the phase string 1@1:0.75@50 would indicate that the
phase needs to be adjusted by 1 degree at 1A and by 0.75 degrees
at 50A.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/local/sensor/{name}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/local/sensor/{name}
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
object (configLocalSensorNameChannel) 
The A/D converter channel configuration of the named sensor.


 
error
number (configLocalSensorNameError) 
The attached sensor's relative output error (ratio error) in
percent. For example, a value of 2.5 would indicate that the
sensor is reading 2.5% higher than nominal. This value is ignored
if member model is CTid.


 
model
string (configLocalSensorNameModel) 
The model name of the attached sensor. If this is CTid, a
CTid®-enabled sensor is attached and the /ctid
service should be used to obtain details about the attached
sensor.


 
phase
string (configLocalSensorNamePhase) 
The phase (timing) adjustment required by the attached sensor.
This value is ignored if member model is CTid.


The format of this string is a colon-separated list of phase- and
amplitude-level pairs of the form p@l, where p is the
phase-adjustment in degrees at 60Hz, and l is a percentage of
the sensor's full scale value.  For example, for a 100A current
sensor, the phase string 1@1:0.75@50 would indicate that the
phase needs to be adjusted by 1 degree at 1A and by 0.75 degrees
at 50A.


 
Responses 
200
Normal response.


401
Unauthorized response.


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


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}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/local/sensor/{name}/channel