${proto.name} ICD
- Generated: ${proto.genTime}
- CRC: ${proto.hash}
- Transport Encoding: (COBS) Consistent Overhead ByteStuffing
Description:
${proto.desc}
Packet Types
-
%for packet in proto.packets:
- ${"[%0.2X]" % packet.packetId} ${packet.name} %endfor
Ping
- Packet ID: [00]
- Requests: Ack
Ping to request an Ack. Used for testing and ICD verification
Fields:
Field | Type | Description |
---|---|---|
icd | uint32_t | 32bit Hash of protocol description. This is used to verify endpoints are using the same protocol |
${packet.name}
- Packet ID: [${"%0.2X" % packet.packetId}] %if packet.hasResponse:
- Requests: ${packet.response.name} %endif %if len(packet.respondsTo) > 0:
- Responds To: \ %for idx,request in enumerate(packet.respondsTo): %if idx == 0: ${request}\ %else: , ${request}\ %endif %endfor %endif
${packet.desc}
%if len(packet.fields) > 0:
Fields:
Field | Type | Description | |
---|---|---|---|
${field.name} | %else:${field.name} | %endif${field.cType}\ %if field.isArray: [${field.arrayLen}]\ %endif | ${field.desc}\
%if field.isEnum:
|
%endif