/config/display

The display (LCD) configuration of the meter.

Get /config/display

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/display

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"backlight": {"brightness": 255,
"duration": 60
},
"contrast": 65,
"fontset": "normal",
"screen": {"use": "ic",
"gen": "ic",
"Grid": "ic",
"Solar": "ic",
"temp": "i",
".default": ""
},
"orientation": 90
},
"error": "Error message (present if an error occurred)."
}

Replace /config/display

SecurityApiKey

Request

Request Body schema: application/json

	object (configDisplayBacklight) The backlight configuration of the display.
contrast	integer (configDisplayContrast) [ 0 .. 127 ] The LCD contrast Zero means no contrast (display is blank), 127 means maximum contrast (display is all black). A value of around 65 usually provides a good contrast.
fontset	string (configDisplayFontset) The fontset to use for the display. Possible values are: `small`: Smaller than the `normal` fontset, this is a lower quality fontset that can fit more text on the display. `normal`: This fontset provides a good tradeoff between font quality and the amount of text that can fit on the display. This should work well for languages with relatively simple characters, such as English or French. `large`: This fontset should work well for languages with more complex characters such as Korean or Chinese. Note The value of this resource needs to be localized (translated) before presenting it to a user. Enum: "small" "normal" "large"
	object (configDisplayScreen) Screen configurations.
orientation	integer (configDisplayOrientation) [ 0 .. 359 ] The angle in degrees by which the orientation of the display should be rotated in the counterclockwise direction. An angle of 0 degree results in the display being aligned with the label on the meter. The value of this resource is rounded to an integer multiple of 90 degrees.

Responses

200

Normal response.

401

Unauthorized response.

put/config/display

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/display

SecurityApiKey

Request

Request Body schema: application/json

	object (configDisplayBacklight) The backlight configuration of the display.
contrast	integer (configDisplayContrast) [ 0 .. 127 ] The LCD contrast Zero means no contrast (display is blank), 127 means maximum contrast (display is all black). A value of around 65 usually provides a good contrast.
fontset	string (configDisplayFontset) The fontset to use for the display. Possible values are: `small`: Smaller than the `normal` fontset, this is a lower quality fontset that can fit more text on the display. `normal`: This fontset provides a good tradeoff between font quality and the amount of text that can fit on the display. This should work well for languages with relatively simple characters, such as English or French. `large`: This fontset should work well for languages with more complex characters such as Korean or Chinese. Note The value of this resource needs to be localized (translated) before presenting it to a user. Enum: "small" "normal" "large"
	object (configDisplayScreen) Screen configurations.
orientation	integer (configDisplayOrientation) [ 0 .. 359 ] The angle in degrees by which the orientation of the display should be rotated in the counterclockwise direction. An angle of 0 degree results in the display being aligned with the label on the meter. The value of this resource is rounded to an integer multiple of 90 degrees.

Responses

200

Normal response.

401

Unauthorized response.

post/config/display

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/display

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey

Responses

200

Normal response.

401

Unauthorized response.

delete/config/display

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

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

➔ Next to /config/display/backlight