Раздел API

Порт устройства

Обмен байтами с портом устройства из списка (COM, TCP, HID): отправить и прочитать ответ.

POST /api/v1/channels/{id}/exchange Отправить байты в порт и получить ответ

Отправить байты в порт и получить ответ#

POST/api/v1/channels/{id}/exchange

Только для портов, добавленных на странице настройки (вид «Порт устройства»). Сразу, не операция

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

Тело запроса application/json обязательное

Поля · ExchangeRequest

hexstring
base64string
textstring
charsetstring
readTimeoutMsinteger int32
от 0
до 60000
maxBytesinteger int32
от 1
до 65536
untilstring
startstring
lengthinteger int32
от 1
lengthOffsetinteger int32
от 0
lengthBytesinteger int32
lengthAdjustinteger int32
crcstring
crcSkipinteger int32
от 0

JSON

{
  "hex": "string",
  "base64": "string",
  "text": "string",
  "charset": "string",
  "readTimeoutMs": 0,
  "maxBytes": 1,
  "until": "string",
  "start": "string",
  "length": 1,
  "lengthOffset": 0,
  "lengthBytes": 1,
  "lengthAdjust": 1,
  "crc": "string",
  "crcSkip": 0
}

Ответ 200 application/json

Поля · ExchangeResult

bytesinteger int32
hexstring
base64string
textstring
crcValidboolean

Ошибки — problem+json с полем code, см. коды ошибок.

Пример запроса

curl

curl -X POST 'http://localhost:7790/api/v1/channels/1/exchange' \
  -H 'Content-Type: application/json' \
  --data '{"hex":"string","base64":"string","text":"string","charset":"string","readTimeoutMs":0,"maxBytes":1,"until":"string","start":"string","length":1,"lengthOffset":0,"lengthBytes":1,"lengthAdjust":1,"crc":"string","crcSkip":0}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/channels/1/exchange' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"hex":"string","base64":"string","text":"string","charset":"string","readTimeoutMs":0,"maxBytes":1,"until":"string","start":"string","length":1,"lengthOffset":0,"lengthBytes":1,"lengthAdjust":1,"crc":"string","crcSkip":0}'