Set RS485 Baud Rate

Sets the serial baud rate on a device that supports RS485. This endpoint sends a configuration command to the device and waits for device confirmation.

Note

baudRate is the baud rate to write to the device, in bps. The valid range is 1 to 65535.

Applicability

• Only devices with RS485 capability and baud-rate configuration support are supported.
• Call List Devices to obtain deviceId, then call List Device Type Definitions to confirm device capabilities.
• Changing the baud rate affects subsequent RS485 transceive communication. Ensure the RS485 slave uses the same baud rate.

Rate Limit

Configuration command endpoints are rate limited to protect device stability. If the response is 429 RATE_LIMITED, retry only after the Retry-After response header or retryAfterSeconds value allows it.

Synchronous Wait

• The first request waits synchronously for up to about 10 seconds.
• If the device confirms the configuration within the wait window, the response returns status=SUCCESS with the written value in result.baudRate.
• If no confirmation is received within the wait window, the response returns status=TIMEOUT; this means the configuration was not confirmed successful, and result is usually absent.
• If the caller retries with the same Idempotency-Key while the original request is still waiting for device confirmation, the response may return SENT.

Endpoint

PUT /wlte/v1/devices/{deviceId}/rs485/baud-rate

Authorization Requirements

Scope	Required	Description
device:config	Yes	Modify RS485 baud rate configuration on the target device

Request

Full URL:

PUT {baseUrl}/wlte/v1/devices/{deviceId}/rs485/baud-rate

Request headers:

Authorization: Bearer {accessToken}
Content-Type: application/json
Accept: application/json
Idempotency-Key: <caller-generated unique string>

Path parameters:

Parameter	Type	Required	Rule
deviceId	string	Yes	Must not be empty

Request body:

{
  "baudRate": 9600
}

Body fields:

Field	Type	Required	Rule
baudRate	integer	Yes	Baud rate in bps, from 1 to 65535

Idempotency-Key

Idempotency-Key is a required request header. It is a unique string generated by the caller to identify one configuration intent. The server uses it to prevent duplicate execution caused by network retries or application-layer retries.

Scenario	Action
Setting a new RS485 baud rate	Generate a new key
Request sent but network timeout, no response received	Reuse the original key for the same request
Received 429 RATE_LIMITED and retrying the same request	Reuse the original key for the same request
baudRate or target device changes	Generate a new key

Repeated request behavior:

• Same client, same key + same body: returns the original command id and current status; command is not executed again.
• Same key but different body: returns 409 IDEMPOTENCY_CONFLICT.
• The server retains idempotency records for about 48 hours; after expiry the same key is treated as a new request.

Success Response

HTTP status:

202 Accepted

Response body (device confirmed):

{
  "code": "COMMAND_ACCEPTED",
  "message": "Command accepted.",
  "requestId": "req_001",
  "data": {
    "id": "cmd_001",
    "deviceId": "rek053537488",
    "type": "RS485_BAUD_RATE_SET",
    "status": "SUCCESS",
    "result": {
      "baudRate": 9600
    },
    "createdAt": "2026-06-11T00:00:00Z"
  }
}

Response body (wait window timed out):

{
  "code": "COMMAND_ACCEPTED",
  "message": "Command accepted.",
  "requestId": "req_001",
  "data": {
    "id": "cmd_001",
    "deviceId": "rek053537488",
    "type": "RS485_BAUD_RATE_SET",
    "status": "TIMEOUT",
    "createdAt": "2026-06-11T00:00:00Z"
  }
}

Response data Schema

Field	Type	Required	Description
id	string	Yes	Unique command identifier; persist this for subsequent result polling
deviceId	string	Yes	Device identifier
type	string	Yes	Command type, always RS485_BAUD_RATE_SET
status	string	Yes	Command status. Enum: SENT, SUCCESS, FAILED, TIMEOUT
result	object	No	Command result. May be absent on timeout or failure
result.baudRate	integer	No	RS485 baud rate written by this command, in bps
createdAt	string	Yes	Command creation time in RFC3339 UTC

Get Command Result

If the initial response does not provide a final result, or if your integration needs to confirm status later, call Get Command Result with data.id.

To read the current RS485 baud rate cached by the service, call Get Device Configuration. result.baudRate is the value confirmed for this configuration command.

Error Responses

Possible responses:

• 400 INVALID_REQUEST
• 401 AUTH_REQUIRED
• 401 AUTH_INVALID
• 401 AUTH_EXPIRED
• 403 AUTH_SCOPE_DENIED
• 404 DEVICE_NOT_FOUND
• 409 IDEMPOTENCY_CONFLICT
• 422 COMMAND_REJECTED
• 422 DEVICE_OFFLINE
• 429 RATE_LIMITED
• 503 GATEWAY_UNAVAILABLE
• 500 INTERNAL_ERROR