fix: push working state for 0.2.0 and improve frame struct

Author: spectrachrome

CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--
+    Add new changelog entries here.
+    Each entry may be annotated with "Added", "Changed", "Removed", and "Fixed" titles.
+
+    Example:
+
+    ## [1.0.0] - May 16, 2022
+
+    ### Added
+    - New visual identity.
+
+    ### Changed
+    - Start using "changelog" over "change log" since it's the common usage.
+
+    ### Removed
+    - Section about "changelog" vs "CHANGELOG".
+
+    ### Fixed
+    - Fix typos in recent README changes.
+    - Update outdated unreleased diff link.
+-->
+
+## Unreleased
+
+### Added
+- Human-readable changelogs.

Cargo.lock

@@ -6,8 +6,11 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+accelerometer = "0.12.0"
 bincode = "1.3.3"
 chrono = "0.4.31"
+nanoid = "0.4.0"
 serde = "1.0.195"
 serde_derive = "1.0.195"
 serde_json = "1.0.111"
+uuid = { version = "1.7.0", features = ["serde", "v4"] }

Cargo.toml

@@ -0,0 +1,19 @@
+//! A JSON-serialiable message format for WebSocket communication between master nodes and connected GUI clients.
+//! 
+//! This message frame is simpler than the one used for UWB, as the client messages are only transferred between master nodes and connected GUI clients. Using a client link not only provides
+//! a way to control and monitor controller games, it's also useful to run diagnostics and do time-travel debugging, inspecting controller events and game states in real-time.
+
+
+pub struct ClientFrame {
+
+}
+
+pub struct ClientHeader {
+    /// A ten-byte long unique message identifier generated by the `nanoid` crate.
+    pub id: String,
+}
+
+pub enum ClientPayload {
+    /// Set global controller brightness as a percentage between 0.0 and 1.0.
+    SetBrightness(f32),
+}

src/client.rs

@@ -0,0 +1,11 @@
+//! Error types for when something goes wrong with an UWB frame, like serialization or deserialization errors.
+
+use serde_derive::{Serialize, Deserialize};
+
+#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
+pub enum FrameError {
+    /// An error occurred while serializing or deserializing the packet.
+    SerializeError,
+    /// The magic string "LEDswarm" was not found at the start of the byte buffer, so the received datagram is not a valid LEDswarm UWB packet.
+    NoMagicString(String),
+}

src/frame/error.rs

@@ -0,0 +1,53 @@
+//! A data structure for the header of a frame, which contains metadata about the frame, such as the sender and target IDs, the universe number, and the current tick.
+
+use serde_derive::{Serialize, Deserialize};
+use nanoid::nanoid;
+use chrono::DateTime;
+
+#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
+pub struct FrameHeader {
+    /// When the frame was sent, as a string representation of a `DateTime` object.
+    pub timestamp: String,
+    /// How many times this message will be redirected by the mesh before being dropped.
+    pub lifetime: u8,
+    /// A small unique message identifier generated by the `nanoid` crate.
+    pub message_id: String,
+    /// The assigned ID of the sender of the frame. If the sender does not have an ID yet (trying to join the mesh), this field is set to 65535.
+    pub sender_id: u16,
+    /// The assigned ID of the target of the frame, broadcasting to all nodes if set to `None`.
+    pub target_id: Option<u16>,
+    // If set, the sender of the frame expects an acknowledgement from the receiver and will retry until it receives one.
+    pub requires_acknowledgement: bool,
+    /// The current repeating synchronization tick as an integer between 0 and 65535.
+    pub current_tick: u16,
+    /// Used to separate different logical networks in the same physical network, to play multiple games next to each other without interference.
+    pub universe: u8,
+    /// The ranging data from the UWB module, which is used to calculate the distance between the sender and the receiver.
+    pub ranging_bytes: [u8; 4],
+}
+
+/*
+self.uwb_out_tx.send(UwbPacket {
+            sender_id: u16::MAX,
+            target_id: Some(0),
+            timestamp: "now".to_string(),
+            ranging_bytes: [0, 0, 0, 0],
+            message:   UwbMessage::JoinRequest,
+            lifetime: 1,
+        }).unwrap(); */
+
+impl FrameHeader {
+    pub fn new() -> Self {
+        Self {
+            timestamp: DateTime::<chrono::Local>::from(chrono::Local::now()).to_rfc3339(),
+            lifetime: 2,
+            message_id: nanoid!(10),
+            sender_id: u16::MAX,
+            requires_acknowledgement: false,
+            target_id: None,
+            current_tick: 0,
+            universe: 0,
+            ranging_bytes: [0; 4],
+        }
+    }
+}