Skip to content

Commit

Permalink
update readme and change log (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
inquestruss authored Oct 7, 2023
1 parent c4ed510 commit f47093b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,16 @@ Initial restructuring of the package as we move it from private to public.
- Canboat PGN definitions without samples (that is, no logs including the PGN/variant have been submitted to Canboat) are tracked separately--when they're found in logs the samples should be submitted to the project.
- Imports canboat.json from an interim version forked on Boatkit while we wait for the project to address issues related to values with lengths not known in the PGN definition.

### 2023-10-05
Release v0.0.1

- Switched back to Canboat's canboat.json.

### 2023-10-07
Release v0.0.2
Moved from Pipeline constructed from channels to a much simpler model connecting each stage
through function variables.




8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ See the source to replay as an example of the intended use model.

Responsible for managing the interaction with the nmea gateway (or to replay a recording of message frames received from a gateway or other source). To support a new gateway create a new implementation that supports this interface definition.

The endpoint puts new message frames onto a channel. The data format is determined by the gateway or other source.
The endpoint passes new message frames to the adapter through its input function. The data format is determined by the gateway or other source.

### Frame to Packet Adapter

Responsible for generating a "packet" from frames received on its input channel, and putting complete packets onto its output channel. The packet is an intermediate format used by subsequent processors.
Responsible for generating a "packet" from frames received through its input function, and passes complete packets on through its output function. The packet is an intermediate format used by subsequent processors.

This adapter can access a number of helper functions:
- is the PGN known (defined in canboat)?
Expand All @@ -52,7 +52,7 @@ This adapter can access a number of helper functions:

### Packet to Struct Adapter

Receives packet on its input channel, decodes it, and puts the resulting Go struct on its output channel (or an UnknownPGN if it fails to decode the packet).
Receives packet through its input function, decodes it, and passes the resulting Go struct (or an UnknownPGN if it fails to decode the packet) on through its output function.

### Subscribe

Expand All @@ -77,5 +77,3 @@ See [changelog](./changelog.md)
## License
[n2k license](./LICENSE)



0 comments on commit f47093b

Please sign in to comment.