APA & APB added #113
Closed
APA & APB added #113
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elpiel
requested changes
Jan 10, 2024
There was a problem hiding this comment.
Thank you very much for opening this PR and working on the 2 sentences.
As discussed on Discord, the parsing should happen from NMEA 0183 sentence and not JSON. Json (de)serialization is achieved using derive macro - derive(Serialize, Deserialize)
Please, take a look at the other modules and use the nom crate to parse the sentences.
src/sentences/apa.rs
Outdated
Comment on lines
42
to
60
| impl fmt::Display for APASentence { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| write!( | ||
| f, | ||
| "{{\"sentence_type\":\"{}\",\"cross_track_error\":{},\"direction_to_steer\":\"{}\",\"status\":\"{}\",\"cross_track_units\":\"{}\",\"waypoint_id\":\"{}\",\"bearing_to_destination\":{:0.1},\"heading_to_destination\":\"{}\",\"arrival_circle_entered\":\"{}\",\"perimeter_laid\":\"{}\",\"steer_to_heading\":\"{}\"}}", | ||
| self.sentence_type, | ||
| self.cross_track_error, | ||
| self.direction_to_steer, | ||
| self.status, | ||
| self.cross_track_units, | ||
| self.waypoint_id, | ||
| self.bearing_to_destination, | ||
| self.heading_to_destination, | ||
| self.arrival_circle_entered, | ||
| self.perimeter_laid, | ||
| self.steer_to_heading, | ||
| ) | ||
| } | ||
| } |
There was a problem hiding this comment.
- You should not user
std::fmtsince this crate definesno_stdwhere std is not available.
To implement Json, you need toderive(Serialize, Deserialize)for the type
src/sentences/apa.rs
Outdated
Comment on lines
62
to
79
| fn main() { | ||
| let apa_sentence = APASentence { | ||
| sentence_type: String::from("$APA"), | ||
| cross_track_error: 1.5, | ||
| direction_to_steer: 'L', | ||
| status: 'A', | ||
| cross_track_units: 'N', | ||
| waypoint_id: String::from("WPT001"), | ||
| bearing_to_destination: 45.0, | ||
| heading_to_destination: 'T', | ||
| arrival_circle_entered: 'A', | ||
| perimeter_laid: 'N', | ||
| steer_to_heading: 'N', | ||
| }; | ||
|
|
||
| let nmea_sentence = apa_sentence.to_string(); | ||
| println!("NMEA APA Sentence: {}", nmea_sentence); | ||
| } |
There was a problem hiding this comment.
The main function is only applicable to binaries.
- Please remove the
mainfn
src/sentences/apa.rs
Outdated
Comment on lines
81
to
97
| #[test] | ||
| fn test_apa_sentence_serialization() { | ||
| let apa_sentence = APASentence { | ||
| sentence_type: String::from("$APA"), | ||
| cross_track_error: 1.5, | ||
| direction_to_steer: 'L', | ||
| status: 'A', | ||
| cross_track_units: 'N', | ||
| waypoint_id: String::from("WPT001"), | ||
| bearing_to_destination: 45.0, | ||
| heading_to_destination: 'T', | ||
| arrival_circle_entered: 'A', | ||
| perimeter_laid: 'N', | ||
| steer_to_heading: 'N', | ||
| }; | ||
|
|
||
| let expected_json = r#"{"sentence_type":"$APA","cross_track_error":1.5,"direction_to_steer":"L","status":"A","cross_track_units":"N","waypoint_id":"WPT001","bearing_to_destination":45.0,"heading_to_destination":"T","arrival_circle_entered":"A","perimeter_laid":"N","steer_to_heading":"N"}"#; |
There was a problem hiding this comment.
- The test should contain parsing from NMEA 0183 sentence and not JSON.
- tests should be contained in their own module
tests
src/sentences/apb.rs
Outdated
There was a problem hiding this comment.
The same comments apply to this sentences too.
Co-authored-by: Lachezar Lechev <8925621+elpiel@users.noreply.github.com>
Co-authored-by: Lachezar Lechev <8925621+elpiel@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.