Skip to content

Commit

Permalink
docs updates, fix the path to the JSON
Browse files Browse the repository at this point in the history
  • Loading branch information
jr1221 committed Dec 30, 2024
1 parent 7f1cf56 commit e07d607
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 23 deletions.
26 changes: 4 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,29 +41,11 @@ Now view calypso interpret the can message and broadcast it on `mqttui`

### Simulation Mode
#### Run from build
- Same setup as above, then use the entry point `simulate` instead of `main`
- ```cargo run --bin simulate```
- ```cargo run --bin simulate -- -u localhost:1883```
- Same setup as above, then use the package `calypso-simulate` instead of the default `calypso`.
- ```cargo run -p calypso-simulate```
- ```cargo run -p calypso-simulate -- -u localhost:1883```

#### Run from Docker
- ```docker pull ghcr.io/northeastern-electric-racing/calypso:Develop```
- ```docker run -d --rm --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
- ```docker run -d --rm -e CALYPSO_SIREN_HOST_URL=127.0.0.1:1883 --network host ghcr.io/northeastern-electric-racing/calypso:Develop```



### Generate Proto

#### linux
`apt-get install protobuf-compiler -y`

#### mac
`brew install protobuf`

`cargo install protobuf-codegen`

`PATH="$HOME/.cargo/bin:$PATH"`

`protoc --rust_out ./src ./src/proto/serverdata.proto`

delete the `mod.rs` file
- ```docker run -d --rm -e CALYPSO_SIREN_HOST_URL=127.0.0.1:1883 --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
2 changes: 1 addition & 1 deletion calypso-cangen/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ pub mod validate;
* Used by all daedalus macros
* Filepath is relative to project root (i.e. /Calypso)
*/
pub const CANGEN_SPEC_PATH: &str = "../Embedded-Base/cangen/can-messages";
pub const CANGEN_SPEC_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/../Embedded-Base/cangen/can-messages");

0 comments on commit e07d607

Please sign in to comment.