diff --git a/clover-hub/src/logging.rs b/clover-hub/src/logging.rs index 082c4b1..4a95126 100644 --- a/clover-hub/src/logging.rs +++ b/clover-hub/src/logging.rs @@ -43,7 +43,7 @@ pub fn setup_logging(use_stdout: bool) -> SdkLoggerProvider { .with_thread_names(true) .with_filter(env_filter); - // No, I can't just option the .with(...) because rust is stupid when it comes to traits as types in uninitalized variables. + // No, I can't just option the .with(...) because rust is stupid when it comes to traits as types in uninitialized variables. if use_stdout { let subscriber = tracing_subscriber::registry() .with(otel_layer) diff --git a/clover-hub/src/server/mod.rs b/clover-hub/src/server/mod.rs index a679ff3..ba95181 100644 --- a/clover-hub/src/server/mod.rs +++ b/clover-hub/src/server/mod.rs @@ -103,7 +103,7 @@ pub async fn server_main( Ok(_) => { match connect_db(warehouse_store.clone()).await { Ok(_) => { - debug!("Initalizing Stores..."); + debug!("initializing Stores..."); let renderer_store = RendererStore::new(Some(warehouse_store.config.clone())); let modman_store = ModManStore::new(Some(warehouse_store.config.clone())); let inference_engine_store = @@ -117,7 +117,7 @@ pub async fn server_main( .await .primary_api_key .clone(); - debug!("Stores initalized!"); + debug!("Stores initialized!"); let mut services = Vec::new(); diff --git a/clover-hub/src/server/modman/busses/proxies/group/can_2/lookout.rs b/clover-hub/src/server/modman/busses/proxies/group/can_2/lookout.rs index fbcb18d..59d132f 100644 --- a/clover-hub/src/server/modman/busses/proxies/group/can_2/lookout.rs +++ b/clover-hub/src/server/modman/busses/proxies/group/can_2/lookout.rs @@ -110,7 +110,7 @@ pub fn can_interface_lookout(ctx: Arc, channel: UnboundedSender { if retries == 5 { - error!("Continously failed to get network interfaces even after inital check, did something happen to the network manager?"); + error!("Continously failed to get network interfaces even after initial check, did something happen to the network manager?"); debug!("{err}"); ctx.cancellation_token.cancel(); break; diff --git a/clover-hub/src/server/modman/busses/proxies/group/mod.rs b/clover-hub/src/server/modman/busses/proxies/group/mod.rs index 2c1ebc1..e93f660 100644 --- a/clover-hub/src/server/modman/busses/proxies/group/mod.rs +++ b/clover-hub/src/server/modman/busses/proxies/group/mod.rs @@ -10,7 +10,7 @@ //! //! ## Bus Manager Threads //! -//! Bus manager threads handle the creation and deletion of module threads. These handle the inital handshake between a module and ModMan, and then creat a module manager to handle Zenoh proxying. +//! Bus manager threads handle the creation and deletion of module threads. These handle the initial handshake between a module and ModMan, and then creat a module manager to handle Zenoh proxying. //! //! ## Module Manager Threads //! diff --git a/clover-hub/src/server/modman/components/models.rs b/clover-hub/src/server/modman/components/models.rs index f66b837..b610ee7 100644 --- a/clover-hub/src/server/modman/components/models.rs +++ b/clover-hub/src/server/modman/components/models.rs @@ -7,7 +7,7 @@ use std::sync::Arc; /// All components must implement this trait, ensures standardization between component types, etc. pub trait CloverComponentTrait: Sized { - /// Should initalize the component in the store, and ensure that 2-way communication is setup. + /// Should initialize the component in the store, and ensure that 2-way communication is setup. fn init( &mut self, store: Arc, diff --git a/clover-hub/src/server/modman/components/movement/models.rs b/clover-hub/src/server/modman/components/movement/models.rs index 31fbb39..ac6a962 100644 --- a/clover-hub/src/server/modman/components/movement/models.rs +++ b/clover-hub/src/server/modman/components/movement/models.rs @@ -121,8 +121,8 @@ pub enum DegreesOfFreedomGestureParams { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct MovementComponent { - /// The inital position of this component, also determines how many degrees of freedom it uses. **NON OPTIONAL!** - pub inital_position: DegreesOfFreedom, + /// The initial position of this component, also determines how many degrees of freedom it uses. **NON OPTIONAL!** + pub initial_position: DegreesOfFreedom, pub gesture_config: GestureConfig, pub connection: ConnectionType, } diff --git a/clover-hub/src/server/modman/mod.rs b/clover-hub/src/server/modman/mod.rs index 91996fa..16b4ac8 100644 --- a/clover-hub/src/server/modman/mod.rs +++ b/clover-hub/src/server/modman/mod.rs @@ -113,7 +113,7 @@ pub async fn modman_main( hashmap }; - let mut modules_initalized: usize = 0; + let mut modules_initialized: usize = 0; debug!("Checking for statically defined modules to init..."); if static_modules.len() > 0 { @@ -150,7 +150,7 @@ pub async fn modman_main( drop(config); - info!("Initalizing modules..."); + info!("initializing modules..."); if total_modules > 0 { // Initialize modules that were registered already via configuration and persistence. for (id, module) in modules_to_init.iter() { @@ -158,27 +158,27 @@ pub async fn modman_main( init_module(&init_store, id.clone(), module.clone()).await; if initialized { - modules_initalized += 1; + modules_initialized += 1; } } } else { info!("No static modules to initialize."); } - (modules_initalized, total_modules) + (modules_initialized, total_modules) }) .await; - if let Some((modules_initalized, total_modules)) = init_results { - if modules_initalized != total_modules { - warn!("Initalized {modules_initalized} out of {total_modules} module(s)!"); + if let Some((modules_initialized, total_modules)) = init_results { + if modules_initialized != total_modules { + warn!("initialized {modules_initialized} out of {total_modules} module(s)!"); status_publisher .put("ready:incomplete") .await .unwrap_or_else(|e| error!("Failed to publish status due to:\n{e}")); } else { - if modules_initalized != 0 { - info!("Initalized all {modules_initalized} module(s)"); + if modules_initialized != 0 { + info!("initialized all {modules_initialized} module(s)"); } status_publisher .put("ready") @@ -212,18 +212,18 @@ pub async fn modman_main( }; let total = modules_snapshot.len(); - let mut modules_deinitalized: usize = 0; + let mut modules_deinitialized: usize = 0; if total > 0 { for (id, module) in modules_snapshot { let (de_initialized, _) = deinit_module(&store, id, module).await; - if de_initialized { modules_deinitalized += 1; } + if de_initialized { modules_deinitialized += 1; } } - if modules_deinitalized != total { - warn!("Deinitalized {} out of {} module(s)!", modules_deinitalized, total); + if modules_deinitialized != total { + warn!("Deinitialized {} out of {} module(s)!", modules_deinitialized, total); } else { - info!("Deinitalized all {} module(s)", modules_deinitalized); + info!("Deinitialized all {} module(s)", modules_deinitialized); } } else { debug!("No modules to deinit."); diff --git a/clover-hub/src/server/modman/models/components.rs b/clover-hub/src/server/modman/models/components.rs index 9584cd9..cdd9926 100644 --- a/clover-hub/src/server/modman/models/components.rs +++ b/clover-hub/src/server/modman/models/components.rs @@ -40,7 +40,7 @@ pub struct CloverComponentMeta { /// Friendly name for this component to be shown to the User in any UI. pub name: String, /// Is this component required for the module to work? Default: yes. - /// If any critical component fails to initalize, the module will fail to initalize entirely. + /// If any critical component fails to initialize, the module will fail to initialize entirely. pub critical: bool, /// Where this component is on/in the user. RFQDN formatted, e.g. `com.reboot-codes.CORE.head.eyes.internal` for a HUD display pub location: String, diff --git a/clover-hub/src/server/modman/models/mod.rs b/clover-hub/src/server/modman/models/mod.rs index 51c2771..4d1b7e5 100644 --- a/clover-hub/src/server/modman/models/mod.rs +++ b/clover-hub/src/server/modman/models/mod.rs @@ -21,7 +21,7 @@ pub enum PortStatus { /// Available but unused. #[serde(rename = "available")] Available, - /// Requested by $MODULE_ID, but the UART bus isn't initalized yet + /// Requested by $MODULE_ID, but the UART bus isn't initialized yet #[serde(rename = "requested")] Requested(String), /// Currently being used by $MODULE_ID diff --git a/clover-hub/src/server/modman/modules.rs b/clover-hub/src/server/modman/modules.rs index b38037f..2143389 100644 --- a/clover-hub/src/server/modman/modules.rs +++ b/clover-hub/src/server/modman/modules.rs @@ -75,19 +75,19 @@ pub async fn init_component( if component_meta.critical { info!( - "Module: {}, initalizing CRITICAL component: {}...", + "Module: {}, initializing CRITICAL component: {}...", module_id.clone(), component_id.clone() ); } else { info!( - "Module: {}, initalizing component: {}...", + "Module: {}, initializing component: {}...", module_id.clone(), component_id.clone() ); } - let component_initalized = match component.init(Arc::new(store.clone())).await { + let component_initialized = match component.init(Arc::new(store.clone())).await { Ok(_) => true, Err(e) => { failiure = Some(e); @@ -95,9 +95,9 @@ pub async fn init_component( } }; - if component_initalized { + if component_initialized { info!( - "Module: {}, successfully initalized component: {}!", + "Module: {}, successfully initialized component: {}!", module_id.clone(), component_id.clone() ); @@ -164,7 +164,7 @@ pub async fn init_module(store: &ModManStore, id: String, module: Module) -> (bo critical_failiure = Some((component_id.clone(), e)); } else { error!( - "Module: {}, Failed to initalize component \"{}\", due to: {}", + "Module: {}, Failed to initialize component \"{}\", due to: {}", id.clone(), component_id.clone(), e @@ -180,7 +180,7 @@ pub async fn init_module(store: &ModManStore, id: String, module: Module) -> (bo Some(failiure) => { let (component_id, e) = failiure; error!( - "Module: {}, failed to initalize critical component: {}, due to: {}\nSkipping rest of Module init...", + "Module: {}, failed to initialize critical component: {}, due to: {}\nSkipping rest of Module init...", id.clone(), component_id, e @@ -200,7 +200,7 @@ pub async fn init_module(store: &ModManStore, id: String, module: Module) -> (bo error!("Module: {}, failed to initialize!", id.clone()); } } else { - debug!("Finished initalizing module."); + debug!("Finished initializing module."); initialized_module = true; } } @@ -262,19 +262,19 @@ pub async fn deinit_component( if component_meta.critical { info!( - "Module: {}, deinitalizing CRITICAL component: {}...", + "Module: {}, deinitializing CRITICAL component: {}...", module_id.clone(), component_id.clone() ); } else { info!( - "Module: {}, deinitalizing component: {}...", + "Module: {}, deinitializing component: {}...", module_id.clone(), component_id.clone() ); } - let component_initalized = match component.deinit(Arc::new(store.clone())).await { + let component_initialized = match component.deinit(Arc::new(store.clone())).await { Ok(_) => true, Err(e) => { failiure = Some(e); @@ -282,9 +282,9 @@ pub async fn deinit_component( } }; - if component_initalized { + if component_initialized { info!( - "Module: {}, successfully deinitalized component: {}!", + "Module: {}, successfully deinitialized component: {}!", module_id.clone(), component_id.clone() ); @@ -346,7 +346,7 @@ pub async fn deinit_module(store: &ModManStore, id: String, module: Module) -> ( critical_failiure = Some((component_id.clone(), e)); } else { error!( - "Module: {}, Failed to deinitalize component \"{}\", due to: {}", + "Module: {}, Failed to deinitialize component \"{}\", due to: {}", id.clone(), component_id.clone(), e @@ -360,7 +360,7 @@ pub async fn deinit_module(store: &ModManStore, id: String, module: Module) -> ( Some(failiure) => { let (component_id, e) = failiure; error!( - "Module: {}, failed to deinitalize critical component: {}, due to: {}\nSkipping rest of Module init...", + "Module: {}, failed to deinitialize critical component: {}, due to: {}\nSkipping rest of Module init...", id.clone(), component_id, e diff --git a/clover-hub/src/server/warehouse/mod.rs b/clover-hub/src/server/warehouse/mod.rs index 70bb3a7..23d8b98 100644 --- a/clover-hub/src/server/warehouse/mod.rs +++ b/clover-hub/src/server/warehouse/mod.rs @@ -4,7 +4,7 @@ //! //! Before starting its sibling components, CHServer will first call [`setup_warehouse`] to get the Clover warehouse/primary storage directory (by default: `/opt/clover`) ready for use. //! -//! Later, after an inital connection to Zenoh is initalized, Warehouse will then monitor for [events](ipc) using its primary service defined in [`warehouse_main`]. +//! Later, after an initial connection to Zenoh is initialized, Warehouse will then monitor for [events](ipc) using its primary service defined in [`warehouse_main`]. //! pub mod config; @@ -62,7 +62,7 @@ pub enum Error { /// Warehouse's data directory preparation function. /// /// 1. Ensures that the data directory exists, -/// 2. Loads the core [configuration file](config) (paired management devices, permanently attached hardware, core Modules to initalize, etc), +/// 2. Loads the core [configuration file](config) (paired management devices, permanently attached hardware, core Modules to initialize, etc), /// 3. and preps [Repository storage](repos). #[instrument(skip(store))] pub async fn setup_warehouse(data_dir: String, store: Arc) -> Result<(), Error> { diff --git a/clover-hub/src/server/warehouse/repos/models.rs b/clover-hub/src/server/warehouse/repos/models.rs index 67188c9..e57063f 100644 --- a/clover-hub/src/server/warehouse/repos/models.rs +++ b/clover-hub/src/server/warehouse/repos/models.rs @@ -241,8 +241,8 @@ pub struct RawRepoCreds { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct RawGesturePackSpec { pub name: Option, - #[serde(default)] - pub gestures: OptionalListManifestSpecEntry, + //#[serde(default)] + //pub gestures: OptionalListManifestSpecEntry, } #[cfg(feature = "core")] @@ -312,8 +312,8 @@ pub struct ContainerSpec { pub struct GesturePackSpec { #[serde(default)] pub name: OptionalString, - #[serde(default)] - pub gestures: OptionalStrTHashMap, + //#[serde(default)] + //pub gestures: OptionalStrTHashMap, } #[cfg(feature = "core")] diff --git a/core/gesture-packs/default/gesture-pack.clover.json b/core/gesture-packs/default/gesture-pack.clover.json index b2a0dd5..b2623b1 100644 --- a/core/gesture-packs/default/gesture-pack.clover.json +++ b/core/gesture-packs/default/gesture-pack.clover.json @@ -20,11 +20,11 @@ "keyframes": [ { "x": -45.0, - "y": "@inital" + "y": "@initial" }, { "x": 45.0, - "y": "@inital" + "y": "@initial" } ] } diff --git a/docs/docs/user-guide/1-configuration/0-intro.md b/docs/docs/user-guide/1-configuration/0-intro.md index 4aea045..94d17d3 100644 --- a/docs/docs/user-guide/1-configuration/0-intro.md +++ b/docs/docs/user-guide/1-configuration/0-intro.md @@ -1,3 +1,3 @@ # Configuration -Inital configuration is most... er. *ergonomically* done via Ratchet, which can interactively guide a user through planning, BoM creation, first time setup, debugging, etc. If most of that is done, and a user just needs to setup a kit that's pre-configured, Spanner- the mobile client- can be used to complete setup. +initial configuration is most... er. *ergonomically* done via Ratchet, which can interactively guide a user through planning, BoM creation, first time setup, debugging, etc. If most of that is done, and a user just needs to setup a kit that's pre-configured, Spanner- the mobile client- can be used to complete setup. diff --git a/docs/docs/user-guide/1-configuration/1-ratchet/1-welcome.md b/docs/docs/user-guide/1-configuration/1-ratchet/1-welcome.md index 8667fd4..02dcb90 100644 --- a/docs/docs/user-guide/1-configuration/1-ratchet/1-welcome.md +++ b/docs/docs/user-guide/1-configuration/1-ratchet/1-welcome.md @@ -1,8 +1,8 @@ # Welcome -Opening ratchet for the first time, a user will see the welcome screen, showing any last used connections, and/or the inital setup buttons. +Opening ratchet for the first time, a user will see the welcome screen, showing any last used connections, and/or the initial setup buttons. -## Inital Setup... +## initial Setup... ### From Scratch diff --git a/todo.md b/todo.md index c38cf70..992d060 100644 --- a/todo.md +++ b/todo.md @@ -60,7 +60,7 @@ - [ ] Ratchet - [ ] Transition to Flutter - [ ] use `flutter_scene`, and specifically enable impeller on desktop builds. - - [ ] Inital Setup Flow + - [ ] initial Setup Flow - [ ] i18n - [ ] Repos - [ ] Repo registration @@ -96,7 +96,7 @@ - [ ] CloverHub - [ ] Module proxy config - [ ] User setup - - [ ] Inital config tutorial (WIP, actually) + - [ ] initial config tutorial (WIP, actually) - [ ] Developer Tutorials - [ ] Repo setup - [ ] Manifest setup (clover manifest helper in Deno/TS?)