aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Protocol.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Update Protocol.md to use enumerations for pinsKevin O'Connor2019-07-091-22/+23
| | | | | | | Now that pins use enumerations, update the set_digital_out command examples. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Protocol documentation with enumerationsKevin O'Connor2019-04-011-19/+33
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* command: Always pass a string to the DECL_CONSTANT() macroKevin O'Connor2019-03-171-1/+1
| | | | | | | | Make it clear that the name of the constant being defined is a string. When the value being defined is also a string, use a new DECL_CONSTANT_STR() macro. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in Protocol.md documentKevin O'Connor2019-02-101-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Replace get_status example with get_clock in Protocol.mdKevin O'Connor2018-10-201-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use only single space at start of new sentenceKevin O'Connor2017-05-011-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using "firmware" in the documentationKevin O'Connor2017-04-271-126/+130
| | | | | | | | The term "firmware" is ambiguous - it could refer to the entire project (host and micro-controller software) or to just the micro-controller software. Avoid the term in the documentation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* command: Check for reentrant calls to sendf()Kevin O'Connor2017-01-131-3/+1
| | | | | | | | | Allow sendf() to be called from irq and timer context - check for the case where sendf() is called while already in sendf() and simply discard those messages. This makes it safe to use output() debugging calls even in irq and timer context. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update protocol document with internal VLQ linkKevin O'Connor2016-12-311-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* build: Define DECL_CONSTANT mechanism for defining exported constantsKevin O'Connor2016-12-231-2/+15
| | | | | | | | | Add a DECL_CONSTANT macro to allow the firmware to define constants that are to be exported to the host during the "identify" phase. This replaces the existing hardcoded mechanism of scanning the Kconfig header file for certain constants. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an example to the description of the message block contentsKevin O'Connor2016-12-221-24/+33
| | | | | | | | Use a more real-world example to improve the description of message block contents. Make it more clear that the data dictionary contains and utilizes the full command descriptions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update protocol document to highlight its "compression" systemKevin O'Connor2016-12-211-10/+31
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording change to protocol documentKevin O'Connor2016-12-211-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to protocol documentKevin O'Connor2016-12-211-11/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to wording of some documentsKevin O'Connor2016-12-011-7/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Protocol.md with information on host / firmware communicationKevin O'Connor2016-10-191-0/+296
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 19:14:05 +0000