Spec-Zone.ru › AWS CLI v2

[ aws . iotfleetwise ]

create-decoder-manifest

Описание

Создаёт манифест декодера, связанный с манифестом модели. Для создания манифеста декодера должны выполняться следующие условия:

  • Каждый декодер сигнала имеет уникальное имя.
  • Каждый декодер сигнала связан с сетевым интерфейсом.
  • Каждый сетевой интерфейс имеет уникальный идентификатор.
  • Декодеры сигналов указаны в манифесте модели.

См. также: Документацию API AWS

Синтаксис

  create-decoder-manifest
--name <value>
[--description <value>]
--model-manifest-arn <value>
[--signal-decoders <value>]
[--network-interfaces <value>]
[--default-for-unmapped-signals <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

Уникальное имя создаваемого манифеста декодера.

--description (строка)

Краткое описание манифеста декодера.

--model-manifest-arn (строка)

Amazon Resource Name (ARN) модели транспортного средства (манифест модели).

--signal-decoders (список)

Список информации о декодерах сигналов.

(структура)

Информация о декодере сигнала.

fullyQualifiedName -> (строка)

Полное имя декодера сигнала, определенное в модели транспортного средства.

type -> (строка)

Сеть протокол транспортного средства. Например, CAN_SIGNAL определяет протокол, определяющий, как данные передаются между электронными блоками управления (ЭБУ). OBD_SIGNAL определяет протокол, определяющий, как передаются данные самодиагностики между ЭБУ.

interfaceId -> (строка)

Идентификатор сетевого интерфейса, указывающий, какой сетевой протокол использует транспортное средство.

canSignal -> (структура)

Информация о декодере сигнала, использующего протокол Controller Area Network (CAN).

messageId -> (целое число)

Идентификатор сообщения.

isBigEndian -> (булево)

Указывает, является ли порядок байтов в сообщении CAN big-endian.

isSigned -> (булево)

Определяет, является ли сообщение знаковым (true) или беззнаковым (false). Если знаковое, сообщение может представлять как положительные, так и отрицательные числа. Параметр isSigned применяется только к типу сигнала INTEGER, и не влияет на тип сигнала FLOATING_POINT.

startBit -> (целое число)

Указывает начало сигнала CAN. Оно всегда должно быть наименее значимым битом (LSB).

Это значение может отличаться от значения в файле DBC. Для сигналов little-endian, значение startBit совпадает со значением в файле DBC. Для сигналов big-endian в файле DBC, начальный бит является наиболее значимым битом (MSB). Вам нужно будет рассчитать LSB и передать его как startBit.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании с фактором, вычисление является value = raw_value * factor + offset.

factor -> (двойное число)

Множитель, используемый для декодирования сообщения CAN.

length -> (целое число)

Количество байтов данных в сообщении.

name -> (строка)

Имя сигнала.

signalValueType -> (строка)

Тип значения сигнала. Значение по умолчанию - INTEGER.

obdSignal -> (структура)

Информация о декодере сигнала, использующего протокол on-board diagnostic (OBD) II.

pidResponseLength -> (целое число)

Длина запрашиваемых данных.

serviceMode -> (целое число)

Режим работы (диагностический сервис) в сообщении.

pid -> (целое число)

Диагностический код, используемый для запроса данных от транспортного средства для этого сигнала.

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление является value = raw_value * scaling + offset.

startByte -> (целое число)

Указывает начало сообщения.

byteLength -> (целое число)

Длина сообщения.

bitRightShift -> (целое число)

Количество позиций для сдвига битов в сообщении.

bitMaskLength -> (целое число)

Количество битов для маскирования в сообщении.

isSigned -> (булево)

Определяет, является ли сообщение знаковым (true) или беззнаковым (false). Если знаковое, сообщение может представлять как положительные, так и отрицательные числа. Параметр isSigned применяется только к типу сигнала INTEGER, и не влияет на тип сигнала FLOATING_POINT. Значение по умолчанию - false.

signalValueType -> (строка)

Тип значения сигнала. Значение по умолчанию - INTEGER.

messageSignal -> (структура)

Информация о декодировании конкретного сообщения, поддерживающего типы данных высшего порядка.

topicName -> (строка)

Имя темы для сигнала сообщения. Соответствует темам в ROS 2.

structuredMessage -> (структура помеченных объединений)

Структурированное сообщение для сигнала сообщения. Оно может быть определено с помощью primitiveMessageDefinition, structuredMessageListDefinition, или structuredMessageDefinition рекурсивно.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченных объединений)

Представляет узел примитивного типа в сложной структуре данных.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: ros2PrimitiveMessageDefinition.

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, использующем совместимый с ROS 2 примитивный тип сообщения сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей точкой, булево и т.д.) для определения примитивного сообщения ROS 2.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление является value = raw_value * scaling + offset.

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING.

structuredMessageListDefinition -> (структура)

Представляет узел типа списка в сложной структуре данных.

name -> (строка)

Имя определения списка структурированных сообщений.

memberType -> (структура помеченных объединений)

Тип элемента в списке структурированных сообщений.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченных объединений)

Представляет узел примитивного типа в сложной структуре данных.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: ros2PrimitiveMessageDefinition.

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, использующем совместимый с ROS 2 примитивный тип сообщения сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей точкой, булево и т.д.) для определения примитивного сообщения ROS 2.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление является value = raw_value * scaling + offset.

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING.

structuredMessageListDefinition -> (структура)

Представляет узел типа списка в сложной структуре данных.

name -> (строка)

Имя определения списка структурированных сообщений.

( … рекурсивно … )listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY.

structuredMessageDefinition -> (список)

Представляет узел типа структуры в сложной структуре данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType.

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевом языке.

( … рекурсивно … )

listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY.

structuredMessageDefinition -> (список)

Представляет узел типа структуры в сложной структуре данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType.

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевом языке.

dataType -> (структура помеченных объединений)

Тип данных.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченных объединений)

Представляет узел примитивного типа в сложной структуре данных.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан: ros2PrimitiveMessageDefinition.

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, использующем совместимый с ROS 2 примитивный тип сообщения сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей точкой, булево и т.д.) для определения примитивного сообщения ROS 2.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление является value = raw_value * scaling + offset.

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING.

structuredMessageListDefinition -> (структура)

Представляет узел типа списка в сложной структуре данных.

name -> (строка)

Имя определения списка структурированных сообщений.

( … рекурсивно … )listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY.

structuredMessageDefinition -> (список)

Представляет узел типа структуры в сложной структуре данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType.

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевом языке.

( … рекурсивно … )

customDecodingSignal -> (структура)

Информация о пользовательском декодере сигнала.

Предупреждение

Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность областей Amazon Web Services и функций в Руководстве разработчика Amazon Web Services IoT FleetWise.

id -> (строка)

Идентификатор сигнала.

Синтаксис JSON:

[
  {
    "fullyQualifiedName": "string",
    "type": "CAN_SIGNAL"|"OBD_SIGNAL"|"MESSAGE_SIGNAL"|"CUSTOM_DECODING_SIGNAL",
    "interfaceId": "string",
    "canSignal": {
      "messageId": integer,
      "isBigEndian": true|false,
      "isSigned": true|false,
      "startBit": integer,
      "offset": double,
      "factor": double,
      "length": integer,
      "name": "string",
      "signalValueType": "INTEGER"|"FLOATING_POINT"
    },
    "obdSignal": {
      "pidResponseLength": integer,
      "serviceMode": integer,
      "pid": integer,
      "scaling": double,
      "offset": double,
      "startByte": integer,
      "byteLength": integer,
      "bitRightShift": integer,
      "bitMaskLength": integer,
      "isSigned": true|false,
      "signalValueType": "INTEGER"|"FLOATING_POINT"
    },
    "messageSignal": {
      "topicName": "string",
      "structuredMessage": {
        "primitiveMessageDefinition": {
          "ros2PrimitiveMessageDefinition": {
            "primitiveType": "BOOL"|"BYTE"|"CHAR"|"FLOAT32"|"FLOAT64"|"INT8"|"UINT8"|"INT16"|"UINT16"|"INT32"|"UINT32"|"INT64"|"UINT64"|"STRING"|"WSTRING",
            "offset": double,
            "scaling": double,
            "upperBound": long
          }
        },
        "structuredMessageListDefinition": {
          "name": "string",
          "memberType": {
            "primitiveMessageDefinition": {
              "ros2PrimitiveMessageDefinition": {
                "primitiveType": "BOOL"|"BYTE"|"CHAR"|"FLOAT32"|"FLOAT64"|"INT8"|"UINT8"|"INT16"|"UINT16"|"INT32"|"UINT32"|"INT64"|"UINT64"|"STRING"|"WSTRING",
                "offset": double,
                "scaling": double,
                "upperBound": long
              }
            },
            "structuredMessageListDefinition": {
              "name": "string",
              "memberType": { ... recursive ... },
              "listType": "FIXED_CAPACITY"|"DYNAMIC_UNBOUNDED_CAPACITY"|"DYNAMIC_BOUNDED_CAPACITY",
              "capacity": integer
            },
            "structuredMessageDefinition": [
              {
                "fieldName": "string",
                "dataType": { ... recursive ... }
              }
              ...
            ]
          },
          "listType": "FIXED_CAPACITY"|"DYNAMIC_UNBOUNDED_CAPACITY"|"DYNAMIC_BOUNDED_CAPACITY",
          "capacity": integer
        },
        "structuredMessageDefinition": [
          {
            "fieldName": "string",
            "dataType": {
              "primitiveMessageDefinition": {
                "ros2PrimitiveMessageDefinition": {
                  "primitiveType": "BOOL"|"BYTE"|"CHAR"|"FLOAT32"|"FLOAT64"|"INT8"|"UINT8"|"INT16"|"UINT16"|"INT32"|"UINT32"|"INT64"|"UINT64"|"STRING"|"WSTRING",
                  "offset": double,
                  "scaling": double,
                  "upperBound": long
                }
              },
              "structuredMessageListDefinition": {
                "name": "string",
                "memberType": { ... recursive ... },
                "listType": "FIXED_CAPACITY"|"DYNAMIC_UNBOUNDED_CAPACITY"|"DYNAMIC_BOUNDED_CAPACITY",
                "capacity": integer
              },
              "structuredMessageDefinition": [
                {
                  "fieldName": "string",
                  "dataType": { ... recursive ... }
                }
                ...
              ]
            }
          }
          ...
        ]
      }
    },
    "customDecodingSignal": {
      "id": "string"
    }
  }
  ...
]

--network-interfaces (список)

Список информации о доступных сетевых интерфейсах.

(структура)

Представляет узел и его характеристики в сети связи внутри транспортного средства. Все декодеры сигналов должны быть связаны с узлом сети.

Для получения этой информации обо всех сетевых интерфейсах, указанных в манифесте декодера, используйте операцию API.

interfaceId -> (строка)

Идентификатор сетевого интерфейса.

type -> (строка)

Сеть протокол для транспортного средства. Например, CAN_SIGNAL задаёт протокол, который определяет, как данные передаются между электронными управляющими устройствами (ECU). OBD_SIGNAL задаёт протокол, который определяет, как передаются данные самодиагностики между ECU.

canInterface -> (структура)

Информация о сетевом интерфейсе, заданном протоколом Controller Area Network (CAN).

name -> (строка)

Уникальное имя интерфейса.

protocolName -> (строка)

Имя протокола связи для интерфейса.

protocolVersion -> (строка)

Версия протокола связи для интерфейса.

obdInterface -> (структура)

Информация о сетевом интерфейсе, заданном протоколом диагностики на борту (OBD) II.

name -> (строка)

Имя интерфейса.

requestMessageId -> (целое число)

Идентификатор сообщения, запрашивающего данные о транспортном средстве.

obdStandard -> (строка)

Стандартный идентификатор OBD II PID.

pidRequestIntervalSeconds -> (целое число)

Максимальное количество запросов сообщений в секунду.

dtcRequestIntervalSeconds -> (целое число)

Максимальное количество запросов сообщений для диагностического кода неисправности в секунду.

useExtendedIds -> (логическое значение)

Использовать расширенные идентификаторы в сообщении.

hasTransmissionEcu -> (логическое значение)

Есть ли в транспортном средстве модуль управления трансмиссией (TCM).

vehicleMiddleware -> (структура)

Средства для взаимодействия с транспортным средством, определённые как тип сетевого интерфейса. Примеры средств для взаимодействия с транспортным средством включают ROS2 и SOME/IP.

name -> (строка)

Имя средств для взаимодействия с транспортным средством.

protocolName -> (строка)

Имя протокола средств для взаимодействия с транспортным средством.

customDecodingInterface -> (структура)

Информация о пользовательском сетевом интерфейсе.

name -> (строка)

Имя интерфейса.

Краткий синтаксис:

interfaceId=string,type=string,canInterface={name=string,protocolName=string,protocolVersion=string},obdInterface={name=string,requestMessageId=integer,obdStandard=string,pidRequestIntervalSeconds=integer,dtcRequestIntervalSeconds=integer,useExtendedIds=boolean,hasTransmissionEcu=boolean},vehicleMiddleware={name=string,protocolName=string},customDecodingInterface={name=string} ...

Синтаксис JSON:

[
  {
    "interfaceId": "string",
    "type": "CAN_INTERFACE"|"OBD_INTERFACE"|"VEHICLE_MIDDLEWARE"|"CUSTOM_DECODING_INTERFACE",
    "canInterface": {
      "name": "string",
      "protocolName": "string",
      "protocolVersion": "string"
    },
    "obdInterface": {
      "name": "string",
      "requestMessageId": integer,
      "obdStandard": "string",
      "pidRequestIntervalSeconds": integer,
      "dtcRequestIntervalSeconds": integer,
      "useExtendedIds": true|false,
      "hasTransmissionEcu": true|false
    },
    "vehicleMiddleware": {
      "name": "string",
      "protocolName": "ROS_2"
    },
    "customDecodingInterface": {
      "name": "string"
    }
  }
  ...
]

--default-for-unmapped-signals (строка)

Используйте декодеры по умолчанию для всех несопоставленных сигналов в модели. Вам не нужно предоставлять подробную информацию о декодировании.

Предупреждение

Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность областей Amazon Web Services и функций в руководстве разработчика Amazon Web Services IoT FleetWise.

Возможные значения:

  • CUSTOM_DECODING

--tags (список)

Метаданные, которые можно использовать для управления манифестом декодера.

(структура)

Набор пар «ключ-значение», используемых для управления ресурсом.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение тега.

Краткий синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Передавать произвольные двоичные значения с помощью значения, предоставленного JSON, нельзя, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано значение yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.

Общие параметры

--debug (логическое значение)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла параметров.

--region (строка)

Область, которую следует использовать. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружаться, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо должным образом отформатировать для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод для страницы CLI.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров входных данных CLI.

Вывод

name -> (строка)

Название созданного манифеста декодера.

arn -> (строка)

ARN созданного манифеста декодера.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API