Diagnostic file format
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 170
- Forks
- 39
- PR merge metrics
- No merged PRs in 30d
Description
Here is a proposal to post analyse a network behavior with a dedicated tool.
File/Stream Header
| Entry | type | value if constant | meaning |
|---|---|---|---|
| Magic number | u32 | TODO | To recognize file format |
| Version | u16 | 1 | File format version |
| Start time | u64 | N/A | Start time in ns since UNIX Epoch) |
| Data section | u64 | N/A | Offset of the data section |
Data block header
| Entry | type | meaning |
|---|---|---|
| Block type | u16 | To recognize block format |
| Slave address | u16 | Slave address that generates this block |
| Timestamp | u64 | timestamp of the block in ns |
| Data | Block type dependent | Data of the block. Cf. following sections |
Slave description
Block type: 1
| Entry | type | meaning |
|---|---|---|
| Vendor ID | u32 | cf. SSI doc |
| Product code | u32 | cf. SSI doc |
| Revision number | u32 | cf. SSI doc |
| Serial number | u32 | cf. SSI doc |
DL Status
Block type: 2
| Entry | type | meaning |
|---|---|---|
| DL status | u16 | cf. register doc |
AL Status
Block type: 3
| Entry | type | meaning |
|---|---|---|
| AL status | u16 | cf. register doc |
| AL code | u16 | cf. register doc |
Error counters
Block type: 4
| Entry | type | meaning |
|---|---|---|
| Error counters | sizeof(ErrorCounters) | cf. register doc |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source files, tests, or entry points are named. Start by locating the diagnostic tooling and deciding where this proposed header and block serialization should live, then clarify the format's magic number, data layout, and reader/writer scope. Done should include an agreed format and an implementation plan for producing and parsing diagnostic files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- embedded-iot, networking
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100