Project update 5 of 11
Factsheets are Hexabitz’s take on documentation! They’re a mix between a hardware datasheet and a software cheatsheet. They should get you up to speed on any module and provide quick access to the most needed information, e.g., major component part numbers, module APIs and Commands, etc. The software section features some simple examples as well to provide quick help with the syntax. Factsheets are designed to be printed double-sided and can be kept in nylon sheet covers so that they’re easily accessible when you need them.
Each module factsheet should generally contain the following information:
Module name (part number) and short description.
Technical specifications for major module components including available array ports, connectors, etc.
Module general classification (color-coded category). Please check below.
Factsheet release date.
If a module is programmable, the factsheet contains the following software parts as well:
Module CLI Commands. Note that BOS Commands are not included here rather in a separate factsheet dedicated for BOS. (Same thing also for BOS Messages and APIs.)
Module Messages and Message Codes.
Software release version that corresponds to this factsheet version.
Hexabitz modules are usually organized in the following categories. The factsheets are color-coded according to these categories to help you classify them quickly:
Check links to module Factsheets in the campaign main body (Technical Specifications section in the Documentation column). One example is the H01R00 factsheet. Note that some factsheets are not ready yet.
Do you like this new concept? Please share with us your feedback in this short survey!