update device config
PUT /v2/{{deviceId}}/config
This endpoint updates the configuration settings for a specific device identified by deviceId. It allows users to modify various configuration parameters such as locale, Bluetooth settings, volume limits, and display preferences.
Request Body
The request body must be a JSON object containing the following parameters:
-
name(string): The name of the device. -
config(object): An object containing the configuration settings, which includes:-
locale(string): The language setting for the device. -
bluetoothEnabled(string): Indicates whether Bluetooth is enabled ("1"for true). -
repeatAll(boolean): Specifies if all tracks should be repeated. -
btHeadphonesEnabled(boolean): Indicates if Bluetooth headphones are enabled. -
displayDimTimeout(string): The timeout (seconds) duration for display dimming. -
shutdownTimeout(string): The timeout duration (seconds) for automatic shutdown. -
headphonesVolumeLimited(boolean): Indicates if the volume is limited when using headphones. -
dayTime(string): The time from which "day mode" is active. -
maxVolumeLimit(string): The maximum volume limit setting. -
ambientColour(string): The ambient color in hex format. -
dayDisplayBrightness(string): The brightness setting for daytime display. -
dayYotoDaily(string): Identifier for daily content. Format{cardId}/{chapterKey}/{trackKey}by default, this refers to the first right hand button press, during day mode -
dayYotoRadio(string): Identifier for daytime radio content. Format{cardId}/{chapterKey}/{trackKey}by default, this refers to the second right hand button press, during day mode -
nightTime(string): The time from which "night mode" is active. -
nightMaxVolumeLimit(string): The maximum volume limit for nighttime. -
nightAmbientColour(string): The ambient color for nighttime in hex format. -
nightDisplayBrightness(string): The brightness setting for nighttime display. -
nightYotoDaily(string): Identifier for nightly content. Format{cardId}/{chapterKey}/{trackKey}by default, this refers to the first right hand button press, during night mode -
nightYotoRadio(string): Identifier for nighttime radio content. Format{cardId}/{chapterKey}/{trackKey}by default, this refers to the second right hand button press, during night mode -
hourFormat(string): The format for displaying hours (e.g., "24"). -
displayDimBrightness(string): The brightness level when the display is dimmed. -
volumeLevel(string): The current volume level setting. -
clockFace(string): The design of the clock display. -
alarms(array): An array of alarm settings.
-
Response
On a successful request, the response will return a JSON object with the following structure:
status(string): Indicates the status of the update operation (e.g., success message).
Example Response
{
"status": "ok"
}
This response confirms that the configuration was updated successfully.