/config/local

The configuration of directly attached sensors.

Get /config/local

SecurityApiKey

Request

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

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"sensor": {"L1": {"channel": {"bias": 0,
"mode": "normal",
"scale": -74.013999939
},
"error": 0,
"model": "1:1",
"phase": ""
},
"S1": {"channel": {"bias": 0,
"mode": "normal",
"scale": -206.659896851
},
"error": 0,
"model": "ML-SCT-019-0100",
"phase": "2.96@1.5:2.59@3:2.34@6:2.06@15:1.82@50:1.89@100"
},
"S2": {"channel": {"bias": 0,
"mode": "normal",
"scale": -206.659896851
},
"error": 0,
"model": "ML-SCT-019-0100",
"phase": "2.96@1.5:2.59@3:2.34@6:2.06@15:1.82@50:1.89@100"
}
},
"gain": "normal",
"update-interval": 500
},
"error": "Error message (present if an error occurred)."
}

Replace /config/local

SecurityApiKey

Request

Request Body schema: application/json

	object (configLocalSensor) The sensor configurations.
gain	string (configLocalGain) The amplifier gain to use for the local sensor inputs (`S1` and up). All meters support the value `normal`. Model EG4xxx meters also support the value `high`. This gain increases the input gain to approximately ten times of the normal gain. That is, the sensors are approximately 10 times more sensitive than normal, at the expense of having a 10 times smaller range. Enum: "normal" "high"
update-interval	integer (configLocalUpdateInterval) The interval in milliseconds between measurement updates. The default is 1000ms (one update per second) but some meters support smaller values. The rate of change values are averaged over this period of time.

Responses

200

Normal response.

401

Unauthorized response.

put/config/local

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Update /config/local

SecurityApiKey

Request

Request Body schema: application/json

	object (configLocalSensor) The sensor configurations.
gain	string (configLocalGain) The amplifier gain to use for the local sensor inputs (`S1` and up). All meters support the value `normal`. Model EG4xxx meters also support the value `high`. This gain increases the input gain to approximately ten times of the normal gain. That is, the sensors are approximately 10 times more sensitive than normal, at the expense of having a 10 times smaller range. Enum: "normal" "high"
update-interval	integer (configLocalUpdateInterval) The interval in milliseconds between measurement updates. The default is 1000ms (one update per second) but some meters support smaller values. The rate of change values are averaged over this period of time.

Responses

200

Normal response.

401

Unauthorized response.

post/config/local

Request samples

Payload
curl
Python
JavaScript
Go

application/json

{ }

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

Delete /config/local

Reset configuration to the default (all sensors off).

SecurityApiKey

Responses

200

Normal response.

401

Unauthorized response.

delete/config/local

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"status": "OK",
"error": "Error message (present if an error occurred)."
}

➔ Next to /config/local/gain