${proto.name} ICD

Generated with PolyPacket on ${proto.genTime}
CRC: ${proto.hash}
Transport Encoding: (COBS) Consistent Overhead ByteStuffing

Description:

${proto.desc}

Index

Packet Header
Packets:
- ${"[%0.2X]" % packet.packetId} ${packet.name}
%endif %if len(proto.structs) > 0: Structs:
- ${"[%0.2X]" % struct.packetId} ${struct.name}

Packet Header

Every Packet has a standard 8 byte header

Byte	0	1	2	3	4	5	6	7
field	typeId	reserved	Data Len		Token		Checksum
Type	uint8	uint8	uint16		uint16		uint16

Fields:

Field	Type	Description
TypeId	uint8_t	ID for packet type
Sequence	uint8_t	Sequence number, can be used to ensure packets are not being dropped
Data Length	uint16_t	Total length of packet payload
Token	uint16_t	bit 15 : Ack Flag bits 14:0 : Random 15bit token New Packets generate a 15 bit token. Responding packets copy the token and set the Ack Flag high. This is used for timeout/retries and packet response handlers
Checksum	uint16_t	16bit checksum of payload for error checking

For more detailed information on how field data is serialized and encoded see the documentation for the PolyPacket backend library

Packets

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

Ack

Packet ID: [01]
Responds To: Ping

Fields:

Field	Type	Description
icd	uint32_t	32bit Hash of protocol description.Only present when responding to Ping

%for packet in proto.packets: %if not packet.standard:

${packet.name}

Packet ID: [${"%0.2X" % packet.packetId}]
Requests: ${packet.response.name}
Responds To: \ %for idx,request in enumerate(packet.respondsTo): %if idx == 0: ${request}\ %else: , ${request}\ %endif %endfor

${packet.desc}

%if len(packet.fields) > 0:
Fields: %for field in packet.fields: %if field.isRequired: %else: %endif %endfor

Field	Type	Description
${field.name}	${field.name}	${field.cType}\ %if field.isArray: [${field.arrayLen}]\ %endif	${field.desc}\ %if field.isEnum: %for idx,val in enumerate(field.vals): ${field.valsFormat % idx} : ${val.name} - ${val.desc} %endfor %endif %if field.isMask: %for idx,val in enumerate(field.vals): ${field.valsFormat % (1 << idx)} : ${val.name} - ${val.desc} %endfor %endif

Field

Type

Description

${field.name}

${field.name}

${field.cType}\ %if field.isArray: [${field.arrayLen}]\ %endif

${field.desc}\ %if field.isEnum:

${field.valsFormat % idx} : ${val.name} - ${val.desc}

%endif %if field.isMask:

${field.valsFormat % (1 << idx)} : ${val.name} - ${val.desc}

%endif

%else: ## zero data fields This Packet type does not contain any data fields
%endif

%endif %endfor %if len(proto.structs) > 0:

Structs

%for packet in proto.structs: %if not packet.standard:

${packet.name}

Packet ID: [${"%0.2X" % packet.packetId}]
Requests: ${packet.response.name}
Responds To: \ %for idx,request in enumerate(packet.respondsTo): %if idx == 0: ${request}\ %else: , ${request}\ %endif %endfor

${packet.desc}

%if len(packet.fields) > 0:
Fields: %for field in packet.fields: %if field.isRequired: %else: %endif %endfor

Field	Type	Description
${field.name}	${field.name}	${field.cType}\ %if field.isArray: [${field.arrayLen}]\ %endif	${field.desc}\ %if field.isEnum: %for idx,val in enumerate(field.vals): ${field.valsFormat % idx} : ${val.name} - ${val.desc} %endfor %endif %if field.isMask: %for idx,val in enumerate(field.vals): ${field.valsFormat % (1 << idx)} : ${val.name} - ${val.desc} %endfor %endif

Field

Type

Description

${field.name}

${field.name}

${field.cType}\ %if field.isArray: [${field.arrayLen}]\ %endif

${field.desc}\ %if field.isEnum:

${field.valsFormat % idx} : ${val.name} - ${val.desc}

%endif %if field.isMask:

${field.valsFormat % (1 << idx)} : ${val.name} - ${val.desc}

%endif

%else: ## zero data fields This Packet type does not contain any data fields
%endif

%endif %endfor %endif