joeyahines
/
formaty
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

Updated README.md [CI SKIP]

main
Joey Hines 2022-04-09 13:53:14 -06:00
parent 492e4dfc52
commit 79f8ae641d
No known key found for this signature in database
GPG Key ID: 80F567B5C968F91B
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,21 +1,23 @@
# Formaty # Formaty
A simple configurable binary data parser. Data structures are described using TOML files. A simple configurable binary data parser. Data structures are described using TOML files.
## Formats
All formats in [formats](./formats) are included in the `formaty` binary. See [formats.md](./formats/formats.md) for
more info.
## Example ## Example
Checkout the formats described in [formats](./formats)
```bash ```bash
./formaty formats/ccsds.toml ccsds "[0xe0, 0xa1, 0xc0, 0x00, 0x05, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05]" ./formaty ccsds "[0xe0, 0xa1, 0xc0, 0x00, 0x00, 0x05, 0x01, 0x02, 0x03, 0x04, 0x05]"
```` ````
Output: Output:
``` ```
Version Number: 0 Version Number: 0
Packet Type: 0 Packet Type: 1
Secondary Header Flag: 0 Secondary Header Flag: 0
APID: 1295 APID: 0x200
Sequency Flags: 0 Sequence Flags: 3
Packet Sequence Count: 48 Packet Sequence Count: 0
Data Length: 5 Data Length: 5
Data: [1, 2, 3, 4, 5] Data: [1, 2, 3, 4, 5]
``` ```
@ -26,17 +28,18 @@ Formaty 0.1.0
Arbitrary Binary Data Formatting Arbitrary Binary Data Formatting
USAGE: USAGE:
formaty <config> <format> [data]... formaty [OPTIONS] <format> [data]...
FLAGS: FLAGS:
-h, --help Prints help information -h, --help Prints help information
-V, --version Prints version information -V, --version Prints version information
OPTIONS:
-c, --config <config> Path to the format config
ARGS: ARGS:
<config> Path to the format config
<format> Format to parse data as <format> Format to parse data as
<data>... Raw data <data>... Raw data
``` ```
## License ## License