Skip to content

Commit

Permalink
document how u test calypso
Browse files Browse the repository at this point in the history
  • Loading branch information
jr1221 committed Jun 20, 2024
1 parent 3efcc94 commit 849fba4
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
# Calypso
Custom CAN Decoder for all the data being streamed around the car
Custom CAN decoder to translate CAN messages to MQTT protobuf encoded packets with low latency and a YAML configuration structure.

### Recommended Extensions
View https://www.youtube.com/watch?v=BU1LYFkpJuk for more information

- rust-analyzer
- CodeLLDB
- Even Better TOML
- Error Lens
- Todo Tree
- crates

### Develop setup
#### Go to Settings in VSCode
search Rust-analyzer check and set the command from check -> clippy

Expand All @@ -23,12 +15,29 @@ add following information:
}
```

### SIREN and NERO 2.0 Config
Utilizes MQTT Web Socket to offload data from the car for our telemetry system
To test it on linux, please install:
- mosquitto broker: https://mosquitto.org
- can-utils
- mqttui: https://github.com/EdJoPaTo/mqttui


### Developing

Process for testing:
- run `mosquitto` and leave it open
- run `mqttui` and leave it open
- setup the can network:
- `sudo ip link add dev vcan0 type vcan`
- `sudo ip link set dev vcan0 up`

Developers:
run ```cargo run localhost:1883 vcan0```

To send a can message:
- `cansend vcan0 <ID_IN_HEX>#<PAYLOAD_IN_HEX>`
Ex. `cansend vcan0 702#01010101FFFFFFFF`
Now view calypso interpret the can message and broadcast it on `mqttui`



### Generate Proto

Expand Down

0 comments on commit 849fba4

Please sign in to comment.