Changes between Initial Version and Version 1 of ApiSlotcnt


Ignore:
Timestamp:
Sep 3, 2017, 12:01:01 PM (7 years ago)
Author:
alx
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ApiSlotcnt

    v1 v1  
     1=  Команда slotcnt  =
     2
     3== Назначение команды ==
     4
     5Клманда `slotcnt` позволяет получить информацию о состоянии служебных коммуникационных каналов между активной платой SW-01 и другими платами блока. Активная плата выполняет периодический опрос наличия и состояния плат в каждом слоте блока. Для каждого слота в кассете имеется набор счетчиков, сохраняющих статистику обмена сообщениями с платами.
     6
     7== Ключи запроса ==
     8
     9||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Описание'''  ||
     10||  cmd  ||  строка  ||  да  || "slotcnt" - имя команды ||
     11
     12=== Пример запроса ===
     13
     14 `{"cmd":"slotcnt"}`
     15
     16== Права доступа ==
     17
     18Для выполнения команды `slotcnt` не требуется наличия каких-либо прав.
     19
     20== Возвращаемые данные ==
     21
     22В случае успешного выполнения команда `slotcnt` возвращает JSON-объект со следующими ключами:
     23
     24||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
     25||  cmd  ||  строка  || "slotcnt" - имя команды ||
     26||  slots  ||  массив  || массив JSON-объектов, каждый из которых содержит режим обмена и набор счетчиком, связанные с одним из слотов блока. Описание ключей хэша дано ниже. ||
     27
     28Элементы массива `slots` содержат следующие ключи:
     29
     30||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
     31||  slot  ||  число  || Номер слота. ||
     32||  crcMode  ||  число  || Режим контроля целостности сообщений шины управления:[[br]]0 - XOR8;[[br]]1 - CRC16;[[br]]2 - CRC32. ||
     33||  rx_ok  ||  число  || Число успешно полученных сообщений (сообщений с корректной длиной и верной контрольной суммой). ||
     34||  rx_bytes  ||  число  || Число байт успешно принятых сообщений (сообщений с корректной длиной и верной контрольной суммой). ||
     35||  rx_bad  ||  число  || Число сообщений, принятых с неверной контрольной суммой. ||
     36||  rx_big  ||  число  || Число сообщений, размер которых превышает размер приемного буфера. ||
     37||  rx_short  ||  число  || Число сообщений, размер которых меньше минимально допустимого (2 байта плюс контрольная сумма). ||
     38||  rx_discarded  ||  число  || Число сообщений, отброшенных в результате обнаружения логических ошибок в процессе приема (например два ESC-символа подряд, флаг после ESC-символа и т.п.). ||
     39||  un_requests  ||  число  || Число успешно принятых, но не обработанных запросов. Наличие таких запросов может свидетельствовать о том, что ПО мастер-платы SW-01 устарело, либо о логических ошибках в процессе обмена сообщениями между платами. ||
     40||  tx_ok  ||  число  || Число переданных сообщений. ||
     41||  tx_bytes  ||  число  || Число байт переданных сообщений. ||
     42||  tx_dropped  ||  число  || Число сообщений, полученных от функций верхнего уровня для передачи плате, но отброшенных транспортом из-за превышения максимально допустимого размера. ||
     43
     44== Пример ответа ==
     45
     46{{{
     47{
     48  "cmd":"slotcnt",
     49  "slots":[
     50    {
     51      "crcMode":0,
     52      "rx_bad":0,
     53      "rx_big":0,
     54      "rx_bytes":2860967,
     55      "rx_discarded":0,
     56      "rx_ok":111783,
     57      "rx_short":0,
     58      "slot":1,
     59      "tx_bytes":1021078,
     60      "tx_dropped":0,
     61      "tx_ok":111783,
     62      "un_requests":0
     63    },
     64    {
     65      "crcMode":0,
     66      "rx_bad":0,
     67      "rx_big":0,
     68      "rx_bytes":3006498,
     69      "rx_discarded":0,
     70      "rx_ok":111744,
     71      "rx_short":0,
     72      "slot":2,
     73      "tx_bytes":1044286,
     74      "tx_dropped":0,
     75      "tx_ok":111746,
     76      "un_requests":0
     77    },
     78    .....
     79    {
     80      "crcMode":0,
     81      "rx_bad":0,
     82      "rx_big":0,
     83      "rx_bytes":0,
     84      "rx_discarded":0,
     85      "rx_ok":0,
     86      "rx_short":0,
     87      "slot":22,
     88      "tx_bytes":399385,
     89      "tx_dropped":0,
     90      "tx_ok":48609,
     91      "un_requests":0
     92    }
     93  ]
     94}
     95}}}
     96
     97== См. также ==
     98
     99[wiki:ApiBoard команда board]