From de4e6183b3d144480c7780be22ce0b5983ab2928 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 12 Feb 2024 15:51:37 +0100 Subject: [PATCH] Re-structure sat-rs - Add new shared subcrate satrs-shared to split off some shared components not expected to change very often. - Renmame `satrs-core` to `satrs`. It is expected that sat-rs will remain the primary crate, so the core information is superfluous, and core also implies stability, which will not be the case for some time. --- Cargo.toml | 3 +- README.md | 8 +- automation/Jenkinsfile | 2 +- satrs-example/Cargo.toml | 10 +- satrs-example/src/acs.rs | 8 +- satrs-example/src/bin/simpleclient.rs | 8 +- satrs-example/src/ccsds.rs | 6 +- satrs-example/src/config.rs | 22 +- satrs-example/src/events.rs | 2 +- satrs-example/src/hk.rs | 2 +- satrs-example/src/lib.rs | 8 +- satrs-example/src/main.rs | 18 +- satrs-example/src/pus/action.rs | 14 +- satrs-example/src/pus/event.rs | 14 +- satrs-example/src/pus/hk.rs | 14 +- satrs-example/src/pus/mod.rs | 12 +- satrs-example/src/pus/scheduler.rs | 14 +- satrs-example/src/pus/stack.rs | 2 +- satrs-example/src/pus/test.rs | 24 +-- satrs-example/src/requests.rs | 6 +- satrs-example/src/tcp.rs | 2 +- satrs-example/src/tm_funnel.rs | 2 +- satrs-example/src/tmtc.rs | 16 +- satrs-example/src/udp.rs | 4 +- satrs-mib/Cargo.toml | 14 +- satrs-mib/README.md | 3 + satrs-mib/codegen/Cargo.toml | 18 +- satrs-mib/codegen/tests/basic.rs | 4 +- satrs-mib/codegen/tests/basic_with_info.rs | 4 +- satrs-mib/codegen/tests/verify_gen_struct.rs | 4 +- satrs-mib/src/res_code.rs | 16 +- satrs-shared/CHANGELOG.md | 18 ++ satrs-shared/Cargo.toml | 28 +++ {satrs-core => satrs-shared}/LICENSE-APACHE | 0 {satrs-core => satrs-shared}/NOTICE | 0 satrs-shared/README.md | 5 + satrs-shared/src/lib.rs | 3 + {satrs-core => satrs-shared}/src/res_code.rs | 26 ++- {satrs-core => satrs}/.gitignore | 0 {satrs-core => satrs}/CHANGELOG.md | 0 {satrs-core => satrs}/Cargo.toml | 19 +- satrs/LICENSE-APACHE | 201 ++++++++++++++++++ satrs/NOTICE | 1 + {satrs-core => satrs}/README.md | 3 +- {satrs-core => satrs}/release-checklist.md | 0 {satrs-core => satrs}/src/cfdp/dest.rs | 0 {satrs-core => satrs}/src/cfdp/filestore.rs | 0 {satrs-core => satrs}/src/cfdp/mod.rs | 0 {satrs-core => satrs}/src/cfdp/source.rs | 0 {satrs-core => satrs}/src/cfdp/user.rs | 0 {satrs-core => satrs}/src/device.rs | 0 {satrs-core => satrs}/src/encoding/ccsds.rs | 0 {satrs-core => satrs}/src/encoding/cobs.rs | 2 +- {satrs-core => satrs}/src/encoding/mod.rs | 0 {satrs-core => satrs}/src/event_man.rs | 0 {satrs-core => satrs}/src/events.rs | 2 +- {satrs-core => satrs}/src/executable.rs | 0 {satrs-core => satrs}/src/hal/mod.rs | 0 {satrs-core => satrs}/src/hal/std/mod.rs | 0 .../src/hal/std/tcp_cobs_server.rs | 0 .../src/hal/std/tcp_server.rs | 0 .../src/hal/std/tcp_spacepackets_server.rs | 0 .../src/hal/std/udp_server.rs | 4 +- {satrs-core => satrs}/src/hk.rs | 0 {satrs-core => satrs}/src/lib.rs | 2 +- {satrs-core => satrs}/src/mode.rs | 0 {satrs-core => satrs}/src/objects.rs | 2 +- {satrs-core => satrs}/src/params.rs | 2 +- {satrs-core => satrs}/src/pool.rs | 2 +- {satrs-core => satrs}/src/power.rs | 0 {satrs-core => satrs}/src/pus/event.rs | 0 {satrs-core => satrs}/src/pus/event_man.rs | 0 {satrs-core => satrs}/src/pus/event_srv.rs | 0 {satrs-core => satrs}/src/pus/hk.rs | 0 {satrs-core => satrs}/src/pus/mod.rs | 0 {satrs-core => satrs}/src/pus/mode.rs | 0 {satrs-core => satrs}/src/pus/scheduler.rs | 0 .../src/pus/scheduler_srv.rs | 2 +- {satrs-core => satrs}/src/pus/test.rs | 0 {satrs-core => satrs}/src/pus/verification.rs | 10 +- {satrs-core => satrs}/src/request.rs | 0 satrs/src/res_code.rs | 1 + {satrs-core => satrs}/src/seq_count.rs | 0 .../src/tmtc/ccsds_distrib.rs | 4 +- {satrs-core => satrs}/src/tmtc/mod.rs | 0 {satrs-core => satrs}/src/tmtc/pus_distrib.rs | 4 +- {satrs-core => satrs}/src/tmtc/tm_helper.rs | 0 {satrs-core => satrs}/tests/hk_helpers.rs | 0 {satrs-core => satrs}/tests/pools.rs | 2 +- .../tests/pus_autogen_events.rs | 2 +- {satrs-core => satrs}/tests/pus_events.rs | 14 +- .../tests/pus_verification.rs | 10 +- {satrs-core => satrs}/tests/tcp_servers.rs | 2 +- 93 files changed, 466 insertions(+), 189 deletions(-) create mode 100644 satrs-shared/CHANGELOG.md create mode 100644 satrs-shared/Cargo.toml rename {satrs-core => satrs-shared}/LICENSE-APACHE (100%) rename {satrs-core => satrs-shared}/NOTICE (100%) create mode 100644 satrs-shared/README.md create mode 100644 satrs-shared/src/lib.rs rename {satrs-core => satrs-shared}/src/res_code.rs (61%) rename {satrs-core => satrs}/.gitignore (100%) rename {satrs-core => satrs}/CHANGELOG.md (100%) rename {satrs-core => satrs}/Cargo.toml (86%) create mode 100644 satrs/LICENSE-APACHE create mode 100644 satrs/NOTICE rename {satrs-core => satrs}/README.md (73%) rename {satrs-core => satrs}/release-checklist.md (100%) rename {satrs-core => satrs}/src/cfdp/dest.rs (100%) rename {satrs-core => satrs}/src/cfdp/filestore.rs (100%) rename {satrs-core => satrs}/src/cfdp/mod.rs (100%) rename {satrs-core => satrs}/src/cfdp/source.rs (100%) rename {satrs-core => satrs}/src/cfdp/user.rs (100%) rename {satrs-core => satrs}/src/device.rs (100%) rename {satrs-core => satrs}/src/encoding/ccsds.rs (100%) rename {satrs-core => satrs}/src/encoding/cobs.rs (99%) rename {satrs-core => satrs}/src/encoding/mod.rs (100%) rename {satrs-core => satrs}/src/event_man.rs (100%) rename {satrs-core => satrs}/src/events.rs (99%) rename {satrs-core => satrs}/src/executable.rs (100%) rename {satrs-core => satrs}/src/hal/mod.rs (100%) rename {satrs-core => satrs}/src/hal/std/mod.rs (100%) rename {satrs-core => satrs}/src/hal/std/tcp_cobs_server.rs (100%) rename {satrs-core => satrs}/src/hal/std/tcp_server.rs (100%) rename {satrs-core => satrs}/src/hal/std/tcp_spacepackets_server.rs (100%) rename {satrs-core => satrs}/src/hal/std/udp_server.rs (98%) rename {satrs-core => satrs}/src/hk.rs (100%) rename {satrs-core => satrs}/src/lib.rs (94%) rename {satrs-core => satrs}/src/mode.rs (100%) rename {satrs-core => satrs}/src/objects.rs (99%) rename {satrs-core => satrs}/src/params.rs (99%) rename {satrs-core => satrs}/src/pool.rs (99%) rename {satrs-core => satrs}/src/power.rs (100%) rename {satrs-core => satrs}/src/pus/event.rs (100%) rename {satrs-core => satrs}/src/pus/event_man.rs (100%) rename {satrs-core => satrs}/src/pus/event_srv.rs (100%) rename {satrs-core => satrs}/src/pus/hk.rs (100%) rename {satrs-core => satrs}/src/pus/mod.rs (100%) rename {satrs-core => satrs}/src/pus/mode.rs (100%) rename {satrs-core => satrs}/src/pus/scheduler.rs (100%) rename {satrs-core => satrs}/src/pus/scheduler_srv.rs (99%) rename {satrs-core => satrs}/src/pus/test.rs (100%) rename {satrs-core => satrs}/src/pus/verification.rs (99%) rename {satrs-core => satrs}/src/request.rs (100%) create mode 100644 satrs/src/res_code.rs rename {satrs-core => satrs}/src/seq_count.rs (100%) rename {satrs-core => satrs}/src/tmtc/ccsds_distrib.rs (99%) rename {satrs-core => satrs}/src/tmtc/mod.rs (100%) rename {satrs-core => satrs}/src/tmtc/pus_distrib.rs (98%) rename {satrs-core => satrs}/src/tmtc/tm_helper.rs (100%) rename {satrs-core => satrs}/tests/hk_helpers.rs (100%) rename {satrs-core => satrs}/tests/pools.rs (93%) rename {satrs-core => satrs}/tests/pus_autogen_events.rs (99%) rename {satrs-core => satrs}/tests/pus_events.rs (94%) rename {satrs-core => satrs}/tests/pus_verification.rs (97%) rename {satrs-core => satrs}/tests/tcp_servers.rs (99%) diff --git a/Cargo.toml b/Cargo.toml index eaeb356..6cd72ab 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,10 @@ [workspace] resolver = "2" members = [ - "satrs-core", + "satrs", "satrs-mib", "satrs-example", + "satrs-shared", ] exclude = [ diff --git a/README.md b/README.md index b3e7341..e7931b2 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,12 @@ This project currently contains following crates: Primary information resource in addition to the API documentation, hosted [here](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/). It can be useful to read this first before delving into the example application and the API documentation. -* [`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core): - Core components of sat-rs. -* [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-example): +* [`satrs`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs): + Primary crate. +* [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example): Example of a simple example on-board software using various sat-rs components which can be run on a host computer or on any system with a standard runtime like a Raspberry Pi. -* [`satrs-mib`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-mib): +* [`satrs-mib`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-mib): Components to build a mission information base from the on-board software directly. * [`satrs-example-stm32f3-disco`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example-stm32f3-disco): Example of a simple example on-board software using sat-rs components on a bare-metal system diff --git a/automation/Jenkinsfile b/automation/Jenkinsfile index 9ba4afa..507dee0 100644 --- a/automation/Jenkinsfile +++ b/automation/Jenkinsfile @@ -47,7 +47,7 @@ pipeline { } stage('Check Cross Embedded Bare Metal') { steps { - sh 'cargo check -p satrs-core --target thumbv7em-none-eabihf --no-default-features' + sh 'cargo check -p satrs --target thumbv7em-none-eabihf --no-default-features' } } stage('Check Cross Embedded Linux') { diff --git a/satrs-example/Cargo.toml b/satrs-example/Cargo.toml index 2b291cc..d7c2298 100644 --- a/satrs-example/Cargo.toml +++ b/satrs-example/Cargo.toml @@ -19,13 +19,13 @@ num_enum = "0.7" thiserror = "1" derive-new = "0.5" -[dependencies.satrs-core] -version = "0.1.0-alpha.3" -# path = "../satrs-core" +[dependencies.satrs] +# version = "0.1.0-alpha.3" +path = "../satrs" [dependencies.satrs-mib] -version = "0.1.0-alpha.2" -# path = "../satrs-mib" +# version = "0.1.0-alpha.2" +path = "../satrs-mib" [features] dyn_tmtc = [] diff --git a/satrs-example/src/acs.rs b/satrs-example/src/acs.rs index 9b4b3ee..dc7763b 100644 --- a/satrs-example/src/acs.rs +++ b/satrs-example/src/acs.rs @@ -1,10 +1,10 @@ use std::sync::mpsc::{self, TryRecvError}; use log::{info, warn}; -use satrs_core::pus::verification::VerificationReporterWithSender; -use satrs_core::pus::{EcssTmSender, PusTmWrapper}; -use satrs_core::spacepackets::ecss::hk::Subservice as HkSubservice; -use satrs_core::{ +use satrs::pus::verification::VerificationReporterWithSender; +use satrs::pus::{EcssTmSender, PusTmWrapper}; +use satrs::spacepackets::ecss::hk::Subservice as HkSubservice; +use satrs::{ hk::HkRequest, spacepackets::{ ecss::tm::{PusTmCreator, PusTmSecondaryHeader}, diff --git a/satrs-example/src/bin/simpleclient.rs b/satrs-example/src/bin/simpleclient.rs index c64aa04..04281ca 100644 --- a/satrs-example/src/bin/simpleclient.rs +++ b/satrs-example/src/bin/simpleclient.rs @@ -1,7 +1,7 @@ -use satrs_core::pus::verification::RequestId; -use satrs_core::spacepackets::ecss::tc::PusTcCreator; -use satrs_core::spacepackets::ecss::tm::PusTmReader; -use satrs_core::{ +use satrs::pus::verification::RequestId; +use satrs::spacepackets::ecss::tc::PusTcCreator; +use satrs::spacepackets::ecss::tm::PusTmReader; +use satrs::{ spacepackets::ecss::{PusPacket, WritablePusPacket}, spacepackets::SpHeader, }; diff --git a/satrs-example/src/ccsds.rs b/satrs-example/src/ccsds.rs index 0706912..e61172e 100644 --- a/satrs-example/src/ccsds.rs +++ b/satrs-example/src/ccsds.rs @@ -1,6 +1,6 @@ -use satrs_core::pus::ReceivesEcssPusTc; -use satrs_core::spacepackets::{CcsdsPacket, SpHeader}; -use satrs_core::tmtc::{CcsdsPacketHandler, ReceivesCcsdsTc}; +use satrs::pus::ReceivesEcssPusTc; +use satrs::spacepackets::{CcsdsPacket, SpHeader}; +use satrs::tmtc::{CcsdsPacketHandler, ReceivesCcsdsTc}; use satrs_example::config::PUS_APID; #[derive(Clone)] diff --git a/satrs-example/src/config.rs b/satrs-example/src/config.rs index bf47691..4cc960f 100644 --- a/satrs-example/src/config.rs +++ b/satrs-example/src/config.rs @@ -1,10 +1,10 @@ -use satrs_core::res_code::ResultU16; +use satrs::res_code::ResultU16; use satrs_mib::res_code::ResultU16Info; use satrs_mib::resultcode; use std::net::Ipv4Addr; use num_enum::{IntoPrimitive, TryFromPrimitive}; -use satrs_core::{ +use satrs::{ events::{EventU32TypedSev, SeverityInfo}, pool::{StaticMemoryPool, StaticPoolConfig}, }; @@ -42,20 +42,20 @@ pub mod tmtc_err { use super::*; #[resultcode] - pub const INVALID_PUS_SERVICE: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 0); + pub const INVALID_PUS_SERVICE: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 0); #[resultcode] - pub const INVALID_PUS_SUBSERVICE: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 1); + pub const INVALID_PUS_SUBSERVICE: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 1); #[resultcode] - pub const PUS_SERVICE_NOT_IMPLEMENTED: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 2); + pub const PUS_SERVICE_NOT_IMPLEMENTED: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 2); #[resultcode] - pub const UNKNOWN_TARGET_ID: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 3); + pub const UNKNOWN_TARGET_ID: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 3); #[resultcode( info = "Not enough data inside the TC application data field. Optionally includes: \ 8 bytes of failure data containing 2 failure parameters, \ P1 (u32 big endian): Expected data length, P2: Found data length" )] - pub const NOT_ENOUGH_APP_DATA: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 2); + pub const NOT_ENOUGH_APP_DATA: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 2); pub const TMTC_RESULTS: &[ResultU16Info] = &[ INVALID_PUS_SERVICE_EXT, @@ -69,13 +69,13 @@ pub mod hk_err { use super::*; #[resultcode] - pub const TARGET_ID_MISSING: ResultU16 = ResultU16::const_new(GroupId::Hk as u8, 0); + pub const TARGET_ID_MISSING: ResultU16 = ResultU16::new(GroupId::Hk as u8, 0); #[resultcode] - pub const UNIQUE_ID_MISSING: ResultU16 = ResultU16::const_new(GroupId::Hk as u8, 1); + pub const UNIQUE_ID_MISSING: ResultU16 = ResultU16::new(GroupId::Hk as u8, 1); #[resultcode] - pub const UNKNOWN_TARGET_ID: ResultU16 = ResultU16::const_new(GroupId::Hk as u8, 2); + pub const UNKNOWN_TARGET_ID: ResultU16 = ResultU16::new(GroupId::Hk as u8, 2); #[resultcode] - pub const COLLECTION_INTERVAL_MISSING: ResultU16 = ResultU16::const_new(GroupId::Hk as u8, 3); + pub const COLLECTION_INTERVAL_MISSING: ResultU16 = ResultU16::new(GroupId::Hk as u8, 3); } #[allow(clippy::enum_variant_names)] diff --git a/satrs-example/src/events.rs b/satrs-example/src/events.rs index aa2369b..81f7d1e 100644 --- a/satrs-example/src/events.rs +++ b/satrs-example/src/events.rs @@ -1,6 +1,6 @@ use std::sync::mpsc::{self, SendError}; -use satrs_core::{ +use satrs::{ event_man::{ EventManager, EventManagerWithMpscQueue, MpscEventReceiver, MpscEventU32SendProvider, SendEventProvider, diff --git a/satrs-example/src/hk.rs b/satrs-example/src/hk.rs index deae635..3147cbf 100644 --- a/satrs-example/src/hk.rs +++ b/satrs-example/src/hk.rs @@ -1,5 +1,5 @@ use derive_new::new; -use satrs_core::spacepackets::ByteConversionError; +use satrs::spacepackets::ByteConversionError; #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum AcsHkIds { diff --git a/satrs-example/src/lib.rs b/satrs-example/src/lib.rs index 97157f4..dac8ab0 100644 --- a/satrs-example/src/lib.rs +++ b/satrs-example/src/lib.rs @@ -1,8 +1,8 @@ use derive_new::new; -use satrs_core::spacepackets::ecss::tc::IsPusTelecommand; -use satrs_core::spacepackets::ecss::PusPacket; -use satrs_core::spacepackets::{ByteConversionError, CcsdsPacket}; -use satrs_core::tmtc::TargetId; +use satrs::spacepackets::ecss::tc::IsPusTelecommand; +use satrs::spacepackets::ecss::PusPacket; +use satrs::spacepackets::{ByteConversionError, CcsdsPacket}; +use satrs::tmtc::TargetId; use std::fmt; use thiserror::Error; diff --git a/satrs-example/src/main.rs b/satrs-example/src/main.rs index 71774ce..32dbfcb 100644 --- a/satrs-example/src/main.rs +++ b/satrs-example/src/main.rs @@ -15,9 +15,9 @@ use crate::pus::stack::PusStack; use crate::tm_funnel::{TmFunnelDynamic, TmFunnelStatic}; use log::info; use pus::test::create_test_service_dynamic; -use satrs_core::hal::std::tcp_server::ServerConfig; -use satrs_core::hal::std::udp_server::UdpTcServer; -use satrs_core::tmtc::tm_helper::SharedTmPool; +use satrs::hal::std::tcp_server::ServerConfig; +use satrs::hal::std::udp_server::UdpTcServer; +use satrs::tmtc::tm_helper::SharedTmPool; use satrs_example::config::pool::{create_sched_tc_pool, create_static_pools}; use satrs_example::config::tasks::{ FREQ_MS_AOCS, FREQ_MS_EVENT_HANDLING, FREQ_MS_PUS_STACK, FREQ_MS_UDP_TMTC, @@ -41,12 +41,12 @@ use crate::tmtc::{ PusTcSourceProviderSharedPool, SharedTcPool, TcSourceTaskDynamic, TcSourceTaskStatic, }; use crate::udp::{StaticUdpTmHandler, UdpTmtcServer}; -use satrs_core::pus::event_man::EventRequestWithToken; -use satrs_core::pus::verification::{VerificationReporterCfg, VerificationReporterWithSender}; -use satrs_core::pus::{EcssTmSender, MpscTmAsVecSender, MpscTmInSharedPoolSender}; -use satrs_core::spacepackets::{time::cds::TimeProvider, time::TimeWriter}; -use satrs_core::tmtc::{CcsdsDistributor, TargetId}; -use satrs_core::ChannelId; +use satrs::pus::event_man::EventRequestWithToken; +use satrs::pus::verification::{VerificationReporterCfg, VerificationReporterWithSender}; +use satrs::pus::{EcssTmSender, MpscTmAsVecSender, MpscTmInSharedPoolSender}; +use satrs::spacepackets::{time::cds::TimeProvider, time::TimeWriter}; +use satrs::tmtc::{CcsdsDistributor, TargetId}; +use satrs::ChannelId; use satrs_example::TargetIdWithApid; use std::collections::HashMap; use std::net::{IpAddr, SocketAddr}; diff --git a/satrs-example/src/pus/action.rs b/satrs-example/src/pus/action.rs index 7c59723..a791506 100644 --- a/satrs-example/src/pus/action.rs +++ b/satrs-example/src/pus/action.rs @@ -1,18 +1,18 @@ use crate::requests::{ActionRequest, Request, RequestWithToken}; use log::{error, warn}; -use satrs_core::pool::{SharedStaticMemoryPool, StoreAddr}; -use satrs_core::pus::verification::{ +use satrs::pool::{SharedStaticMemoryPool, StoreAddr}; +use satrs::pus::verification::{ FailParams, TcStateAccepted, VerificationReporterWithSender, VerificationToken, }; -use satrs_core::pus::{ +use satrs::pus::{ EcssTcAndToken, EcssTcInMemConverter, EcssTcInSharedStoreConverter, EcssTcInVecConverter, EcssTcReceiver, EcssTmSender, MpscTcReceiver, MpscTmAsVecSender, MpscTmInSharedPoolSender, PusPacketHandlerResult, PusPacketHandlingError, PusServiceBase, PusServiceHelper, }; -use satrs_core::spacepackets::ecss::tc::PusTcReader; -use satrs_core::spacepackets::ecss::PusPacket; -use satrs_core::tmtc::tm_helper::SharedTmPool; -use satrs_core::ChannelId; +use satrs::spacepackets::ecss::tc::PusTcReader; +use satrs::spacepackets::ecss::PusPacket; +use satrs::tmtc::tm_helper::SharedTmPool; +use satrs::ChannelId; use satrs_example::config::{tmtc_err, TcReceiverId, TmSenderId, PUS_APID}; use satrs_example::TargetIdWithApid; use std::collections::HashMap; diff --git a/satrs-example/src/pus/event.rs b/satrs-example/src/pus/event.rs index fbbe942..0355d9c 100644 --- a/satrs-example/src/pus/event.rs +++ b/satrs-example/src/pus/event.rs @@ -1,17 +1,17 @@ use std::sync::mpsc; use log::{error, warn}; -use satrs_core::pool::{SharedStaticMemoryPool, StoreAddr}; -use satrs_core::pus::event_man::EventRequestWithToken; -use satrs_core::pus::event_srv::PusService5EventHandler; -use satrs_core::pus::verification::VerificationReporterWithSender; -use satrs_core::pus::{ +use satrs::pool::{SharedStaticMemoryPool, StoreAddr}; +use satrs::pus::event_man::EventRequestWithToken; +use satrs::pus::event_srv::PusService5EventHandler; +use satrs::pus::verification::VerificationReporterWithSender; +use satrs::pus::{ EcssTcAndToken, EcssTcInMemConverter, EcssTcInSharedStoreConverter, EcssTcInVecConverter, MpscTcReceiver, MpscTmAsVecSender, MpscTmInSharedPoolSender, PusPacketHandlerResult, PusServiceHelper, }; -use satrs_core::tmtc::tm_helper::SharedTmPool; -use satrs_core::ChannelId; +use satrs::tmtc::tm_helper::SharedTmPool; +use satrs::ChannelId; use satrs_example::config::{TcReceiverId, TmSenderId, PUS_APID}; pub fn create_event_service_static( diff --git a/satrs-example/src/pus/hk.rs b/satrs-example/src/pus/hk.rs index 5a27e9f..41c98b9 100644 --- a/satrs-example/src/pus/hk.rs +++ b/satrs-example/src/pus/hk.rs @@ -1,18 +1,18 @@ use crate::requests::{Request, RequestWithToken}; use log::{error, warn}; -use satrs_core::hk::{CollectionIntervalFactor, HkRequest}; -use satrs_core::pool::{SharedStaticMemoryPool, StoreAddr}; -use satrs_core::pus::verification::{ +use satrs::hk::{CollectionIntervalFactor, HkRequest}; +use satrs::pool::{SharedStaticMemoryPool, StoreAddr}; +use satrs::pus::verification::{ FailParams, StdVerifReporterWithSender, VerificationReporterWithSender, }; -use satrs_core::pus::{ +use satrs::pus::{ EcssTcAndToken, EcssTcInMemConverter, EcssTcInSharedStoreConverter, EcssTcInVecConverter, EcssTcReceiver, EcssTmSender, MpscTcReceiver, MpscTmAsVecSender, MpscTmInSharedPoolSender, PusPacketHandlerResult, PusPacketHandlingError, PusServiceBase, PusServiceHelper, }; -use satrs_core::spacepackets::ecss::{hk, PusPacket}; -use satrs_core::tmtc::tm_helper::SharedTmPool; -use satrs_core::ChannelId; +use satrs::spacepackets::ecss::{hk, PusPacket}; +use satrs::tmtc::tm_helper::SharedTmPool; +use satrs::ChannelId; use satrs_example::config::{hk_err, tmtc_err, TcReceiverId, TmSenderId, PUS_APID}; use satrs_example::TargetIdWithApid; use std::collections::HashMap; diff --git a/satrs-example/src/pus/mod.rs b/satrs-example/src/pus/mod.rs index 3fe3cea..ec63abe 100644 --- a/satrs-example/src/pus/mod.rs +++ b/satrs-example/src/pus/mod.rs @@ -1,11 +1,11 @@ use crate::tmtc::MpscStoreAndSendError; use log::warn; -use satrs_core::pus::verification::{FailParams, StdVerifReporterWithSender}; -use satrs_core::pus::{EcssTcAndToken, PusPacketHandlerResult, TcInMemory}; -use satrs_core::spacepackets::ecss::tc::PusTcReader; -use satrs_core::spacepackets::ecss::PusServiceId; -use satrs_core::spacepackets::time::cds::TimeProvider; -use satrs_core::spacepackets::time::TimeWriter; +use satrs::pus::verification::{FailParams, StdVerifReporterWithSender}; +use satrs::pus::{EcssTcAndToken, PusPacketHandlerResult, TcInMemory}; +use satrs::spacepackets::ecss::tc::PusTcReader; +use satrs::spacepackets::ecss::PusServiceId; +use satrs::spacepackets::time::cds::TimeProvider; +use satrs::spacepackets::time::TimeWriter; use satrs_example::config::{tmtc_err, CustomPusServiceId}; use std::sync::mpsc::Sender; diff --git a/satrs-example/src/pus/scheduler.rs b/satrs-example/src/pus/scheduler.rs index 8ffe8df..c3bc7d3 100644 --- a/satrs-example/src/pus/scheduler.rs +++ b/satrs-example/src/pus/scheduler.rs @@ -2,17 +2,17 @@ use std::sync::mpsc; use std::time::Duration; use log::{error, info, warn}; -use satrs_core::pool::{PoolProvider, StaticMemoryPool, StoreAddr}; -use satrs_core::pus::scheduler::{PusScheduler, TcInfo}; -use satrs_core::pus::scheduler_srv::PusService11SchedHandler; -use satrs_core::pus::verification::VerificationReporterWithSender; -use satrs_core::pus::{ +use satrs::pool::{PoolProvider, StaticMemoryPool, StoreAddr}; +use satrs::pus::scheduler::{PusScheduler, TcInfo}; +use satrs::pus::scheduler_srv::PusService11SchedHandler; +use satrs::pus::verification::VerificationReporterWithSender; +use satrs::pus::{ EcssTcAndToken, EcssTcInMemConverter, EcssTcInSharedStoreConverter, EcssTcInVecConverter, MpscTcReceiver, MpscTmAsVecSender, MpscTmInSharedPoolSender, PusPacketHandlerResult, PusServiceHelper, }; -use satrs_core::tmtc::tm_helper::SharedTmPool; -use satrs_core::ChannelId; +use satrs::tmtc::tm_helper::SharedTmPool; +use satrs::ChannelId; use satrs_example::config::{TcReceiverId, TmSenderId, PUS_APID}; use crate::tmtc::PusTcSourceProviderSharedPool; diff --git a/satrs-example/src/pus/stack.rs b/satrs-example/src/pus/stack.rs index 33bd5af..98718be 100644 --- a/satrs-example/src/pus/stack.rs +++ b/satrs-example/src/pus/stack.rs @@ -1,4 +1,4 @@ -use satrs_core::pus::EcssTcInMemConverter; +use satrs::pus::EcssTcInMemConverter; use super::{ action::Pus8Wrapper, event::Pus5Wrapper, hk::Pus3Wrapper, scheduler::Pus11Wrapper, diff --git a/satrs-example/src/pus/test.rs b/satrs-example/src/pus/test.rs index 1958055..45670cc 100644 --- a/satrs-example/src/pus/test.rs +++ b/satrs-example/src/pus/test.rs @@ -1,19 +1,19 @@ use log::{info, warn}; -use satrs_core::params::Params; -use satrs_core::pool::{SharedStaticMemoryPool, StoreAddr}; -use satrs_core::pus::test::PusService17TestHandler; -use satrs_core::pus::verification::{FailParams, VerificationReporterWithSender}; -use satrs_core::pus::{ +use satrs::params::Params; +use satrs::pool::{SharedStaticMemoryPool, StoreAddr}; +use satrs::pus::test::PusService17TestHandler; +use satrs::pus::verification::{FailParams, VerificationReporterWithSender}; +use satrs::pus::{ EcssTcAndToken, EcssTcInMemConverter, EcssTcInVecConverter, MpscTcReceiver, MpscTmAsVecSender, MpscTmInSharedPoolSender, PusPacketHandlerResult, PusServiceHelper, }; -use satrs_core::spacepackets::ecss::tc::PusTcReader; -use satrs_core::spacepackets::ecss::PusPacket; -use satrs_core::spacepackets::time::cds::TimeProvider; -use satrs_core::spacepackets::time::TimeWriter; -use satrs_core::tmtc::tm_helper::SharedTmPool; -use satrs_core::ChannelId; -use satrs_core::{events::EventU32, pus::EcssTcInSharedStoreConverter}; +use satrs::spacepackets::ecss::tc::PusTcReader; +use satrs::spacepackets::ecss::PusPacket; +use satrs::spacepackets::time::cds::TimeProvider; +use satrs::spacepackets::time::TimeWriter; +use satrs::tmtc::tm_helper::SharedTmPool; +use satrs::ChannelId; +use satrs::{events::EventU32, pus::EcssTcInSharedStoreConverter}; use satrs_example::config::{tmtc_err, TcReceiverId, TmSenderId, PUS_APID, TEST_EVENT}; use std::sync::mpsc::{self, Sender}; diff --git a/satrs-example/src/requests.rs b/satrs-example/src/requests.rs index 031f0f4..1d42b55 100644 --- a/satrs-example/src/requests.rs +++ b/satrs-example/src/requests.rs @@ -1,7 +1,7 @@ use derive_new::new; -use satrs_core::hk::HkRequest; -use satrs_core::mode::ModeRequest; -use satrs_core::pus::verification::{TcStateAccepted, VerificationToken}; +use satrs::hk::HkRequest; +use satrs::mode::ModeRequest; +use satrs::pus::verification::{TcStateAccepted, VerificationToken}; use satrs_example::TargetIdWithApid; #[allow(dead_code)] diff --git a/satrs-example/src/tcp.rs b/satrs-example/src/tcp.rs index b9f3052..566b445 100644 --- a/satrs-example/src/tcp.rs +++ b/satrs-example/src/tcp.rs @@ -4,7 +4,7 @@ use std::{ }; use log::{info, warn}; -use satrs_core::{ +use satrs::{ hal::std::tcp_server::{ServerConfig, TcpSpacepacketsServer}, spacepackets::PacketId, tmtc::{CcsdsDistributor, CcsdsError, TmPacketSourceCore}, diff --git a/satrs-example/src/tm_funnel.rs b/satrs-example/src/tm_funnel.rs index 5024e57..af35045 100644 --- a/satrs-example/src/tm_funnel.rs +++ b/satrs-example/src/tm_funnel.rs @@ -4,7 +4,7 @@ use std::{ }; use log::info; -use satrs_core::{ +use satrs::{ pool::{PoolProvider, StoreAddr}, seq_count::{CcsdsSimpleSeqCountProvider, SequenceCountProviderCore}, spacepackets::{ diff --git a/satrs-example/src/tmtc.rs b/satrs-example/src/tmtc.rs index 7ab891c..f615f23 100644 --- a/satrs-example/src/tmtc.rs +++ b/satrs-example/src/tmtc.rs @@ -1,14 +1,14 @@ use log::warn; -use satrs_core::pus::{EcssTcAndToken, ReceivesEcssPusTc}; -use satrs_core::spacepackets::SpHeader; +use satrs::pus::{EcssTcAndToken, ReceivesEcssPusTc}; +use satrs::spacepackets::SpHeader; use std::sync::mpsc::{self, Receiver, SendError, Sender, TryRecvError}; use thiserror::Error; use crate::pus::PusReceiver; -use satrs_core::pool::{PoolProvider, SharedStaticMemoryPool, StoreAddr, StoreError}; -use satrs_core::spacepackets::ecss::tc::PusTcReader; -use satrs_core::spacepackets::ecss::PusPacket; -use satrs_core::tmtc::ReceivesCcsdsTc; +use satrs::pool::{PoolProvider, SharedStaticMemoryPool, StoreAddr, StoreError}; +use satrs::spacepackets::ecss::tc::PusTcReader; +use satrs::spacepackets::ecss::PusPacket; +use satrs::tmtc::ReceivesCcsdsTc; #[derive(Debug, Clone, PartialEq, Eq, Error)] pub enum MpscStoreAndSendError { @@ -133,7 +133,7 @@ impl TcSourceTaskStatic { Ok((pus_tc, _)) => { self.pus_receiver .handle_tc_packet( - satrs_core::pus::TcInMemory::StoreAddr(addr), + satrs::pus::TcInMemory::StoreAddr(addr), pus_tc.service(), &pus_tc, ) @@ -182,7 +182,7 @@ impl TcSourceTaskDynamic { Ok((pus_tc, _)) => { self.pus_receiver .handle_tc_packet( - satrs_core::pus::TcInMemory::Vec(tc.clone()), + satrs::pus::TcInMemory::Vec(tc.clone()), pus_tc.service(), &pus_tc, ) diff --git a/satrs-example/src/udp.rs b/satrs-example/src/udp.rs index 9e3faa8..b6d1f6b 100644 --- a/satrs-example/src/udp.rs +++ b/satrs-example/src/udp.rs @@ -4,7 +4,7 @@ use std::{ }; use log::{info, warn}; -use satrs_core::{ +use satrs::{ hal::std::udp_server::{ReceiveResult, UdpTcServer}, pool::{PoolProviderWithGuards, SharedStaticMemoryPool, StoreAddr}, tmtc::CcsdsError, @@ -113,7 +113,7 @@ mod tests { sync::{Arc, Mutex}, }; - use satrs_core::{ + use satrs::{ spacepackets::{ ecss::{tc::PusTcCreator, WritablePusPacket}, SpHeader, diff --git a/satrs-mib/Cargo.toml b/satrs-mib/Cargo.toml index ab7083c..de25c48 100644 --- a/satrs-mib/Cargo.toml +++ b/satrs-mib/Cargo.toml @@ -7,7 +7,7 @@ authors = ["Robin Mueller "] description = """ Helper crate of the sat-rs framework to build a mission information base (MIB) from the On-Board Software (OBSW) code directly.""" -homepage = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" +homepage = "https://absatsw.uni-stuttgart.de/projects/sat-rs" repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" license = "Apache-2.0" keywords = ["no-std", "space", "aerospace"] @@ -22,16 +22,14 @@ serde-hex = "0.1.0" version = "1" optional = true -[dependencies.satrs-core] -version = "0.1.0-alpha.3" -# path = "../satrs-core" -# git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" -# branch = "main" -# rev = "35e1f7a983f6535c5571186e361fe101d4306b89" +[dependencies.satrs-shared] +# version = "0.1.0" +path = "../satrs-shared" +features = ["serde"] [dependencies.satrs-mib-codegen] path = "codegen" -version = "0.1.0-alpha.2" +version = "0.1.0" [dependencies.serde] version = "1" diff --git a/satrs-mib/README.md b/satrs-mib/README.md index ac5a5b4..a68d729 100644 --- a/satrs-mib/README.md +++ b/satrs-mib/README.md @@ -1,2 +1,5 @@ satrs-mib ========= + +This helper crate contains the procedural macros for the sat-rs framework. +You can find more information on the [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). diff --git a/satrs-mib/codegen/Cargo.toml b/satrs-mib/codegen/Cargo.toml index a0067df..94ff324 100644 --- a/satrs-mib/codegen/Cargo.toml +++ b/satrs-mib/codegen/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "satrs-mib-codegen" -version = "0.1.0-alpha.2" +version = "0.1.0" edition = "2021" description = "satrs-mib proc macro implementation" homepage = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" @@ -19,12 +19,10 @@ path = "tests/tests.rs" quote = "1" proc-macro2 = "1" -[dependencies.satrs-core] -version = "0.1.0-alpha.3" -# path = "../../satrs-core" -# git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" -# branch = "main" -# rev = "35e1f7a983f6535c5571186e361fe101d4306b89" +[dependencies.syn] +version = "2" +features = ["full"] + [dev-dependencies] trybuild = { version = "1", features = ["diff"] } @@ -32,6 +30,6 @@ trybuild = { version = "1", features = ["diff"] } [dev-dependencies.satrs-mib] path = ".." -[dependencies.syn] -version = "2" -features = ["full"] +[dev-dependencies.satrs-shared] +# version = "0.1.0" +path = "../../satrs-shared" diff --git a/satrs-mib/codegen/tests/basic.rs b/satrs-mib/codegen/tests/basic.rs index d4cf1ab..c5ffb08 100644 --- a/satrs-mib/codegen/tests/basic.rs +++ b/satrs-mib/codegen/tests/basic.rs @@ -1,8 +1,8 @@ //! Basic check which just verifies that everything compiles -use satrs_core::res_code::ResultU16; use satrs_mib::resultcode; +use satrs_shared::res_code::ResultU16; #[resultcode] -const _TEST_RESULT: ResultU16 = ResultU16::const_new(0, 1); +const _TEST_RESULT: ResultU16 = ResultU16::new(0, 1); fn main() {} diff --git a/satrs-mib/codegen/tests/basic_with_info.rs b/satrs-mib/codegen/tests/basic_with_info.rs index 2030920..d9a8a3a 100644 --- a/satrs-mib/codegen/tests/basic_with_info.rs +++ b/satrs-mib/codegen/tests/basic_with_info.rs @@ -1,8 +1,8 @@ //! Basic check which just verifies that everything compiles -use satrs_core::res_code::ResultU16; use satrs_mib::resultcode; +use satrs_shared::res_code::ResultU16; #[resultcode(info = "This is a test result where the first parameter is foo")] -const _TEST_RESULT: ResultU16 = ResultU16::const_new(0, 1); +const _TEST_RESULT: ResultU16 = ResultU16::new(0, 1); fn main() {} diff --git a/satrs-mib/codegen/tests/verify_gen_struct.rs b/satrs-mib/codegen/tests/verify_gen_struct.rs index ccd40e8..6f371e8 100644 --- a/satrs-mib/codegen/tests/verify_gen_struct.rs +++ b/satrs-mib/codegen/tests/verify_gen_struct.rs @@ -1,9 +1,9 @@ -use satrs_core::res_code::ResultU16; use satrs_mib::res_code::ResultU16Info; use satrs_mib::resultcode; +use satrs_shared::res_code::ResultU16; #[resultcode(info = "This is a test result where the first parameter is foo")] -const TEST_RESULT: ResultU16 = ResultU16::const_new(0, 1); +const TEST_RESULT: ResultU16 = ResultU16::new(0, 1); // Create named reference of auto-generated struct, which can be used by IDEs etc. const TEST_RESULT_EXT_REF: &ResultU16Info = &TEST_RESULT_EXT; diff --git a/satrs-mib/src/res_code.rs b/satrs-mib/src/res_code.rs index 39fa90f..c7d0656 100644 --- a/satrs-mib/src/res_code.rs +++ b/satrs-mib/src/res_code.rs @@ -1,7 +1,7 @@ #[cfg(feature = "std")] pub use stdmod::*; -pub use satrs_core::res_code::ResultU16; +pub use satrs_shared::res_code::ResultU16; use serde::{Deserialize, Serialize}; use serde_hex::{SerHex, StrictCapPfx}; @@ -96,8 +96,8 @@ mod tests { // Special solution for this crate because the code generated by a macro will use // satrs_mib::res_code::* use crate as satrs_mib; - use satrs_core::res_code::ResultU16; use satrs_mib::resultcode; + use satrs_shared::res_code::ResultU16; #[derive(Debug)] #[allow(dead_code)] @@ -106,12 +106,12 @@ mod tests { } #[resultcode] - pub const INVALID_PUS_SERVICE: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 0); + pub const INVALID_PUS_SERVICE: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 0); #[resultcode] - pub const INVALID_PUS_SUBSERVICE: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 1); + pub const INVALID_PUS_SUBSERVICE: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 1); #[resultcode(info = "Not enough data inside the TC application data field")] - pub const NOT_ENOUGH_APP_DATA: ResultU16 = ResultU16::const_new(GroupId::Tmtc as u8, 2); + pub const NOT_ENOUGH_APP_DATA: ResultU16 = ResultU16::new(GroupId::Tmtc as u8, 2); pub const TMTC_RESULTS: &[ResultU16Info] = &[ INVALID_PUS_SERVICE_EXT, @@ -119,12 +119,12 @@ mod tests { NOT_ENOUGH_APP_DATA_EXT, ]; - const CSV_NAME: &'static str = "dummy.csv"; + const CSV_NAME: &str = "dummy.csv"; #[test] fn test_printout() { let mut wtrb = csv::WriterBuilder::new(); - wtrb.delimiter(';' as u8); + wtrb.delimiter(b';'); print_resultcodes_as_csv(wtrb, TMTC_RESULTS).expect("Priting result codes failed"); } @@ -133,7 +133,7 @@ mod tests { let csvpath = Path::new(CSV_NAME); let mut wtrb = csv::WriterBuilder::new(); let file = File::create(csvpath).expect("Creating CSV file failed"); - wtrb.delimiter(';' as u8); + wtrb.delimiter(b';'); write_resultcodes_to_csv(wtrb, TMTC_RESULTS, file).expect("CSV export failed"); assert!(csvpath.exists()); let file = File::open(csvpath).expect("Opening CSV file failed"); diff --git a/satrs-shared/CHANGELOG.md b/satrs-shared/CHANGELOG.md new file mode 100644 index 0000000..0392a1c --- /dev/null +++ b/satrs-shared/CHANGELOG.md @@ -0,0 +1,18 @@ +Change Log +======= + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +# [unreleased] + +# [v0.1.1] 2024-02-12 + +- Added missing `#![no_std]` attribute for library +- Fixed unit tests + +# [v0.1.0] 2024-02-12 + +Initial release. diff --git a/satrs-shared/Cargo.toml b/satrs-shared/Cargo.toml new file mode 100644 index 0000000..0f61600 --- /dev/null +++ b/satrs-shared/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "satrs-shared" +description = "Components shared by multiple sat-rs crates" +version = "0.1.0" +edition = "2021" +authors = ["Robin Mueller "] +homepage = "https://absatsw.uni-stuttgart.de/projects/sat-rs" +repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" +license = "Apache-2.0" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] + +[dependencies.serde] +version = "1" +default-features = false +optional = true + +[dependencies.spacepackets] +version = "0.9" +default-features = false + +[features] +serde = ["dep:serde", "spacepackets/serde"] + +[package.metadata.docs.rs] +rustdoc-args = ["--cfg", "doc_cfg", "--generate-link-to-definition"] diff --git a/satrs-core/LICENSE-APACHE b/satrs-shared/LICENSE-APACHE similarity index 100% rename from satrs-core/LICENSE-APACHE rename to satrs-shared/LICENSE-APACHE diff --git a/satrs-core/NOTICE b/satrs-shared/NOTICE similarity index 100% rename from satrs-core/NOTICE rename to satrs-shared/NOTICE diff --git a/satrs-shared/README.md b/satrs-shared/README.md new file mode 100644 index 0000000..27d4de3 --- /dev/null +++ b/satrs-shared/README.md @@ -0,0 +1,5 @@ +satrs-shared +========= + +Subcrate for some shared sat-rs framework components not expected to change very often. +You can find more information on the [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). diff --git a/satrs-shared/src/lib.rs b/satrs-shared/src/lib.rs new file mode 100644 index 0000000..9c6875a --- /dev/null +++ b/satrs-shared/src/lib.rs @@ -0,0 +1,3 @@ +//! This library contains modules shared amongst various sat-rs framework crates. +#![no_std] +pub mod res_code; diff --git a/satrs-core/src/res_code.rs b/satrs-shared/src/res_code.rs similarity index 61% rename from satrs-core/src/res_code.rs rename to satrs-shared/src/res_code.rs index 2ef7a88..0603adf 100644 --- a/satrs-core/src/res_code.rs +++ b/satrs-shared/src/res_code.rs @@ -4,6 +4,7 @@ use spacepackets::ecss::{EcssEnumU16, EcssEnumeration}; use spacepackets::util::UnsignedEnum; use spacepackets::ByteConversionError; +/// Simple [u16] based result code type which also allows to group related resultcodes. #[derive(Debug, Copy, Clone, PartialEq, Eq)] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] pub struct ResultU16 { @@ -12,7 +13,7 @@ pub struct ResultU16 { } impl ResultU16 { - pub const fn const_new(group_id: u8, unique_id: u8) -> Self { + pub const fn new(group_id: u8, unique_id: u8) -> Self { Self { group_id, unique_id, @@ -58,3 +59,26 @@ impl EcssEnumeration for ResultU16 { 16 } } + +#[cfg(test)] +mod tests { + use super::*; + + const RESULT_CODE_CONST: ResultU16 = ResultU16::new(1, 1); + + #[test] + pub fn test_basic() { + let result_code = ResultU16::new(1, 1); + assert_eq!(result_code.unique_id(), 1); + assert_eq!(result_code.group_id(), 1); + assert_eq!(result_code, RESULT_CODE_CONST); + assert_eq!(result_code.raw(), (1_u16 << 8) | 1); + assert_eq!(result_code.pfc(), 16); + assert_eq!(result_code.size(), 2); + let mut buf: [u8; 2] = [0; 2]; + let written = result_code.write_to_be_bytes(&mut buf).unwrap(); + assert_eq!(written, 2); + assert_eq!(buf[0], 1); + assert_eq!(buf[1], 1); + } +} diff --git a/satrs-core/.gitignore b/satrs/.gitignore similarity index 100% rename from satrs-core/.gitignore rename to satrs/.gitignore diff --git a/satrs-core/CHANGELOG.md b/satrs/CHANGELOG.md similarity index 100% rename from satrs-core/CHANGELOG.md rename to satrs/CHANGELOG.md diff --git a/satrs-core/Cargo.toml b/satrs/Cargo.toml similarity index 86% rename from satrs-core/Cargo.toml rename to satrs/Cargo.toml index 0c32388..08ceb4e 100644 --- a/satrs-core/Cargo.toml +++ b/satrs/Cargo.toml @@ -1,16 +1,16 @@ [package] -name = "satrs-core" -version = "0.1.0-alpha.3" +name = "satrs" +version = "0.1.0" edition = "2021" rust-version = "1.61" authors = ["Robin Mueller "] -description = "Core components of the sat-rs framework to build software for remote systems" -homepage = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" +description = "A framework to build software for remote systems" +homepage = "https://absatsw.uni-stuttgart.de/projects/sat-rs" repository = "https://egit.irs.uni-stuttgart.de/rust/sat-rs" license = "Apache-2.0" keywords = ["no-std", "space", "aerospace"] -categories = ["aerospace", "aerospace::space-protocols", "no-std", "hardware-support", "embedded"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +categories = ["aerospace", "aerospace::space-protocols", "no-std", "hardware-support", "embedded"] [dependencies] delegate = ">0.7, <=0.10" @@ -70,12 +70,13 @@ version = "0.5.4" features = ["all"] optional = true +[dependencies.satrs-shared] +# version = "0.1.0" +path = "../satrs-shared" + [dependencies.spacepackets] -version = "0.9.0" +version = "0.9" default-features = false -# git = "https://egit.irs.uni-stuttgart.de/rust/spacepackets.git" -# rev = "297cfad22637d3b07a1b27abe56d9a607b5b82a7" -# branch = "main" [dependencies.cobs] git = "https://github.com/robamu/cobs.rs.git" diff --git a/satrs/LICENSE-APACHE b/satrs/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/satrs/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/satrs/NOTICE b/satrs/NOTICE new file mode 100644 index 0000000..717a583 --- /dev/null +++ b/satrs/NOTICE @@ -0,0 +1 @@ +This software contains code developed at the University of Stuttgart's Institute of Space Systems. diff --git a/satrs-core/README.md b/satrs/README.md similarity index 73% rename from satrs-core/README.md rename to satrs/README.md index a90a2e4..763a2ac 100644 --- a/satrs-core/README.md +++ b/satrs/README.md @@ -5,5 +5,4 @@ satrs-core ====== This crate contains the core components of the sat-rs framework. -You can find more information on [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). - +You can find more information on the [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). diff --git a/satrs-core/release-checklist.md b/satrs/release-checklist.md similarity index 100% rename from satrs-core/release-checklist.md rename to satrs/release-checklist.md diff --git a/satrs-core/src/cfdp/dest.rs b/satrs/src/cfdp/dest.rs similarity index 100% rename from satrs-core/src/cfdp/dest.rs rename to satrs/src/cfdp/dest.rs diff --git a/satrs-core/src/cfdp/filestore.rs b/satrs/src/cfdp/filestore.rs similarity index 100% rename from satrs-core/src/cfdp/filestore.rs rename to satrs/src/cfdp/filestore.rs diff --git a/satrs-core/src/cfdp/mod.rs b/satrs/src/cfdp/mod.rs similarity index 100% rename from satrs-core/src/cfdp/mod.rs rename to satrs/src/cfdp/mod.rs diff --git a/satrs-core/src/cfdp/source.rs b/satrs/src/cfdp/source.rs similarity index 100% rename from satrs-core/src/cfdp/source.rs rename to satrs/src/cfdp/source.rs diff --git a/satrs-core/src/cfdp/user.rs b/satrs/src/cfdp/user.rs similarity index 100% rename from satrs-core/src/cfdp/user.rs rename to satrs/src/cfdp/user.rs diff --git a/satrs-core/src/device.rs b/satrs/src/device.rs similarity index 100% rename from satrs-core/src/device.rs rename to satrs/src/device.rs diff --git a/satrs-core/src/encoding/ccsds.rs b/satrs/src/encoding/ccsds.rs similarity index 100% rename from satrs-core/src/encoding/ccsds.rs rename to satrs/src/encoding/ccsds.rs diff --git a/satrs-core/src/encoding/cobs.rs b/satrs/src/encoding/cobs.rs similarity index 99% rename from satrs-core/src/encoding/cobs.rs rename to satrs/src/encoding/cobs.rs index 2645745..6953c3b 100644 --- a/satrs-core/src/encoding/cobs.rs +++ b/satrs/src/encoding/cobs.rs @@ -13,7 +13,7 @@ use cobs::{decode_in_place, encode, max_encoding_length}; /// /// ``` /// use cobs::decode_in_place_report; -/// use satrs_core::encoding::{encode_packet_with_cobs}; +/// use satrs::encoding::{encode_packet_with_cobs}; // /// const SIMPLE_PACKET: [u8; 5] = [1, 2, 3, 4, 5]; /// const INVERTED_PACKET: [u8; 5] = [5, 4, 3, 2, 1]; diff --git a/satrs-core/src/encoding/mod.rs b/satrs/src/encoding/mod.rs similarity index 100% rename from satrs-core/src/encoding/mod.rs rename to satrs/src/encoding/mod.rs diff --git a/satrs-core/src/event_man.rs b/satrs/src/event_man.rs similarity index 100% rename from satrs-core/src/event_man.rs rename to satrs/src/event_man.rs diff --git a/satrs-core/src/events.rs b/satrs/src/events.rs similarity index 99% rename from satrs-core/src/events.rs rename to satrs/src/events.rs index 20267bd..2b23815 100644 --- a/satrs-core/src/events.rs +++ b/satrs/src/events.rs @@ -18,7 +18,7 @@ //! # Examples //! //! ``` -//! use satrs_core::events::{EventU16, EventU32, EventU32TypedSev, Severity, SeverityHigh, SeverityInfo}; +//! use satrs::events::{EventU16, EventU32, EventU32TypedSev, Severity, SeverityHigh, SeverityInfo}; //! //! const MSG_RECVD: EventU32TypedSev = EventU32TypedSev::const_new(1, 0); //! const MSG_FAILED: EventU32 = EventU32::const_new(Severity::LOW, 1, 1); diff --git a/satrs-core/src/executable.rs b/satrs/src/executable.rs similarity index 100% rename from satrs-core/src/executable.rs rename to satrs/src/executable.rs diff --git a/satrs-core/src/hal/mod.rs b/satrs/src/hal/mod.rs similarity index 100% rename from satrs-core/src/hal/mod.rs rename to satrs/src/hal/mod.rs diff --git a/satrs-core/src/hal/std/mod.rs b/satrs/src/hal/std/mod.rs similarity index 100% rename from satrs-core/src/hal/std/mod.rs rename to satrs/src/hal/std/mod.rs diff --git a/satrs-core/src/hal/std/tcp_cobs_server.rs b/satrs/src/hal/std/tcp_cobs_server.rs similarity index 100% rename from satrs-core/src/hal/std/tcp_cobs_server.rs rename to satrs/src/hal/std/tcp_cobs_server.rs diff --git a/satrs-core/src/hal/std/tcp_server.rs b/satrs/src/hal/std/tcp_server.rs similarity index 100% rename from satrs-core/src/hal/std/tcp_server.rs rename to satrs/src/hal/std/tcp_server.rs diff --git a/satrs-core/src/hal/std/tcp_spacepackets_server.rs b/satrs/src/hal/std/tcp_spacepackets_server.rs similarity index 100% rename from satrs-core/src/hal/std/tcp_spacepackets_server.rs rename to satrs/src/hal/std/tcp_spacepackets_server.rs diff --git a/satrs-core/src/hal/std/udp_server.rs b/satrs/src/hal/std/udp_server.rs similarity index 98% rename from satrs-core/src/hal/std/udp_server.rs rename to satrs/src/hal/std/udp_server.rs index 6f2cb5b..fa117f0 100644 --- a/satrs-core/src/hal/std/udp_server.rs +++ b/satrs/src/hal/std/udp_server.rs @@ -20,8 +20,8 @@ use std::vec::Vec; /// ``` /// use std::net::{IpAddr, Ipv4Addr, SocketAddr, UdpSocket}; /// use spacepackets::ecss::WritablePusPacket; -/// use satrs_core::hal::std::udp_server::UdpTcServer; -/// use satrs_core::tmtc::{ReceivesTc, ReceivesTcCore}; +/// use satrs::hal::std::udp_server::UdpTcServer; +/// use satrs::tmtc::{ReceivesTc, ReceivesTcCore}; /// use spacepackets::SpHeader; /// use spacepackets::ecss::tc::PusTcCreator; /// diff --git a/satrs-core/src/hk.rs b/satrs/src/hk.rs similarity index 100% rename from satrs-core/src/hk.rs rename to satrs/src/hk.rs diff --git a/satrs-core/src/lib.rs b/satrs/src/lib.rs similarity index 94% rename from satrs-core/src/lib.rs rename to satrs/src/lib.rs index 7418693..dbdce2d 100644 --- a/satrs-core/src/lib.rs +++ b/satrs/src/lib.rs @@ -1,4 +1,4 @@ -//! # Core components of the sat-rs framework +//! # sat-rs: A framework to build on-board software for remote systems //! //! You can find more information about the sat-rs framework on the //! [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). diff --git a/satrs-core/src/mode.rs b/satrs/src/mode.rs similarity index 100% rename from satrs-core/src/mode.rs rename to satrs/src/mode.rs diff --git a/satrs-core/src/objects.rs b/satrs/src/objects.rs similarity index 99% rename from satrs-core/src/objects.rs rename to satrs/src/objects.rs index 0ff117f..f16b567 100644 --- a/satrs-core/src/objects.rs +++ b/satrs/src/objects.rs @@ -10,7 +10,7 @@ //! ```rust //! use std::any::Any; //! use std::error::Error; -//! use satrs_core::objects::{ManagedSystemObject, ObjectId, ObjectManager, SystemObject}; +//! use satrs::objects::{ManagedSystemObject, ObjectId, ObjectManager, SystemObject}; //! //! struct ExampleSysObj { //! id: ObjectId, diff --git a/satrs-core/src/params.rs b/satrs/src/params.rs similarity index 99% rename from satrs-core/src/params.rs rename to satrs/src/params.rs index bc9cc48..5cad28b 100644 --- a/satrs-core/src/params.rs +++ b/satrs/src/params.rs @@ -13,7 +13,7 @@ //! ## Example for primitive type wrapper //! //! ``` -//! use satrs_core::params::{ParamsRaw, ToBeBytes, U32Pair, WritableToBeBytes}; +//! use satrs::params::{ParamsRaw, ToBeBytes, U32Pair, WritableToBeBytes}; //! //! let u32_pair = U32Pair(0x1010, 25); //! assert_eq!(u32_pair.0, 0x1010); diff --git a/satrs-core/src/pool.rs b/satrs/src/pool.rs similarity index 99% rename from satrs-core/src/pool.rs rename to satrs/src/pool.rs index 5e7cb55..d17f565 100644 --- a/satrs-core/src/pool.rs +++ b/satrs/src/pool.rs @@ -10,7 +10,7 @@ //! # Example for the [StaticMemoryPool] //! //! ``` -//! use satrs_core::pool::{PoolProvider, StaticMemoryPool, StaticPoolConfig}; +//! use satrs::pool::{PoolProvider, StaticMemoryPool, StaticPoolConfig}; //! //! // 4 buckets of 4 bytes, 2 of 8 bytes and 1 of 16 bytes //! let pool_cfg = StaticPoolConfig::new(vec![(4, 4), (2, 8), (1, 16)], false); diff --git a/satrs-core/src/power.rs b/satrs/src/power.rs similarity index 100% rename from satrs-core/src/power.rs rename to satrs/src/power.rs diff --git a/satrs-core/src/pus/event.rs b/satrs/src/pus/event.rs similarity index 100% rename from satrs-core/src/pus/event.rs rename to satrs/src/pus/event.rs diff --git a/satrs-core/src/pus/event_man.rs b/satrs/src/pus/event_man.rs similarity index 100% rename from satrs-core/src/pus/event_man.rs rename to satrs/src/pus/event_man.rs diff --git a/satrs-core/src/pus/event_srv.rs b/satrs/src/pus/event_srv.rs similarity index 100% rename from satrs-core/src/pus/event_srv.rs rename to satrs/src/pus/event_srv.rs diff --git a/satrs-core/src/pus/hk.rs b/satrs/src/pus/hk.rs similarity index 100% rename from satrs-core/src/pus/hk.rs rename to satrs/src/pus/hk.rs diff --git a/satrs-core/src/pus/mod.rs b/satrs/src/pus/mod.rs similarity index 100% rename from satrs-core/src/pus/mod.rs rename to satrs/src/pus/mod.rs diff --git a/satrs-core/src/pus/mode.rs b/satrs/src/pus/mode.rs similarity index 100% rename from satrs-core/src/pus/mode.rs rename to satrs/src/pus/mode.rs diff --git a/satrs-core/src/pus/scheduler.rs b/satrs/src/pus/scheduler.rs similarity index 100% rename from satrs-core/src/pus/scheduler.rs rename to satrs/src/pus/scheduler.rs diff --git a/satrs-core/src/pus/scheduler_srv.rs b/satrs/src/pus/scheduler_srv.rs similarity index 99% rename from satrs-core/src/pus/scheduler_srv.rs rename to satrs/src/pus/scheduler_srv.rs index 8976143..9913338 100644 --- a/satrs-core/src/pus/scheduler_srv.rs +++ b/satrs/src/pus/scheduler_srv.rs @@ -8,7 +8,7 @@ use spacepackets::time::cds::TimeProvider; /// This is a helper class for [std] environments to handle generic PUS 11 (scheduling service) /// packets. This handler is able to handle the most important PUS requests for a scheduling -/// service which provides the [PusSchedulerInterface]. +/// service which provides the [PusSchedulerProvider]. /// /// Please note that this class does not do the regular periodic handling like releasing any /// telecommands inside the scheduler. The user can retrieve the wrapped scheduler via the diff --git a/satrs-core/src/pus/test.rs b/satrs/src/pus/test.rs similarity index 100% rename from satrs-core/src/pus/test.rs rename to satrs/src/pus/test.rs diff --git a/satrs-core/src/pus/verification.rs b/satrs/src/pus/verification.rs similarity index 99% rename from satrs-core/src/pus/verification.rs rename to satrs/src/pus/verification.rs index de3ce97..0cf6c24 100644 --- a/satrs-core/src/pus/verification.rs +++ b/satrs/src/pus/verification.rs @@ -15,11 +15,11 @@ //! ``` //! use std::sync::{Arc, mpsc, RwLock}; //! use std::time::Duration; -//! use satrs_core::pool::{PoolProviderWithGuards, StaticMemoryPool, StaticPoolConfig}; -//! use satrs_core::pus::verification::{VerificationReporterCfg, VerificationReporterWithSender}; -//! use satrs_core::seq_count::SeqCountProviderSimple; -//! use satrs_core::pus::MpscTmInSharedPoolSender; -//! use satrs_core::tmtc::tm_helper::SharedTmPool; +//! use satrs::pool::{PoolProviderWithGuards, StaticMemoryPool, StaticPoolConfig}; +//! use satrs::pus::verification::{VerificationReporterCfg, VerificationReporterWithSender}; +//! use satrs::seq_count::SeqCountProviderSimple; +//! use satrs::pus::MpscTmInSharedPoolSender; +//! use satrs::tmtc::tm_helper::SharedTmPool; //! use spacepackets::ecss::PusPacket; //! use spacepackets::SpHeader; //! use spacepackets::ecss::tc::{PusTcCreator, PusTcSecondaryHeader}; diff --git a/satrs-core/src/request.rs b/satrs/src/request.rs similarity index 100% rename from satrs-core/src/request.rs rename to satrs/src/request.rs diff --git a/satrs/src/res_code.rs b/satrs/src/res_code.rs new file mode 100644 index 0000000..6f7d1a9 --- /dev/null +++ b/satrs/src/res_code.rs @@ -0,0 +1 @@ +pub use satrs_shared::res_code::*; diff --git a/satrs-core/src/seq_count.rs b/satrs/src/seq_count.rs similarity index 100% rename from satrs-core/src/seq_count.rs rename to satrs/src/seq_count.rs diff --git a/satrs-core/src/tmtc/ccsds_distrib.rs b/satrs/src/tmtc/ccsds_distrib.rs similarity index 99% rename from satrs-core/src/tmtc/ccsds_distrib.rs rename to satrs/src/tmtc/ccsds_distrib.rs index ea9bf30..74707e4 100644 --- a/satrs-core/src/tmtc/ccsds_distrib.rs +++ b/satrs/src/tmtc/ccsds_distrib.rs @@ -18,8 +18,8 @@ //! # Example //! //! ```rust -//! use satrs_core::tmtc::ccsds_distrib::{CcsdsPacketHandler, CcsdsDistributor}; -//! use satrs_core::tmtc::{ReceivesTc, ReceivesTcCore}; +//! use satrs::tmtc::ccsds_distrib::{CcsdsPacketHandler, CcsdsDistributor}; +//! use satrs::tmtc::{ReceivesTc, ReceivesTcCore}; //! use spacepackets::{CcsdsPacket, SpHeader}; //! use spacepackets::ecss::WritablePusPacket; //! use spacepackets::ecss::tc::{PusTc, PusTcCreator}; diff --git a/satrs-core/src/tmtc/mod.rs b/satrs/src/tmtc/mod.rs similarity index 100% rename from satrs-core/src/tmtc/mod.rs rename to satrs/src/tmtc/mod.rs diff --git a/satrs-core/src/tmtc/pus_distrib.rs b/satrs/src/tmtc/pus_distrib.rs similarity index 98% rename from satrs-core/src/tmtc/pus_distrib.rs rename to satrs/src/tmtc/pus_distrib.rs index e4eefb1..9f3dc4f 100644 --- a/satrs-core/src/tmtc/pus_distrib.rs +++ b/satrs/src/tmtc/pus_distrib.rs @@ -19,8 +19,8 @@ //! //! ```rust //! use spacepackets::ecss::WritablePusPacket; -//! use satrs_core::tmtc::pus_distrib::{PusDistributor, PusServiceProvider}; -//! use satrs_core::tmtc::{ReceivesTc, ReceivesTcCore}; +//! use satrs::tmtc::pus_distrib::{PusDistributor, PusServiceProvider}; +//! use satrs::tmtc::{ReceivesTc, ReceivesTcCore}; //! use spacepackets::SpHeader; //! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader}; //! struct ConcretePusHandler { diff --git a/satrs-core/src/tmtc/tm_helper.rs b/satrs/src/tmtc/tm_helper.rs similarity index 100% rename from satrs-core/src/tmtc/tm_helper.rs rename to satrs/src/tmtc/tm_helper.rs diff --git a/satrs-core/tests/hk_helpers.rs b/satrs/tests/hk_helpers.rs similarity index 100% rename from satrs-core/tests/hk_helpers.rs rename to satrs/tests/hk_helpers.rs diff --git a/satrs-core/tests/pools.rs b/satrs/tests/pools.rs similarity index 93% rename from satrs-core/tests/pools.rs rename to satrs/tests/pools.rs index 94272c0..f2baece 100644 --- a/satrs-core/tests/pools.rs +++ b/satrs/tests/pools.rs @@ -1,4 +1,4 @@ -use satrs_core::pool::{PoolGuard, PoolProvider, StaticMemoryPool, StaticPoolConfig, StoreAddr}; +use satrs::pool::{PoolGuard, PoolProvider, StaticMemoryPool, StaticPoolConfig, StoreAddr}; use std::ops::DerefMut; use std::sync::mpsc; use std::sync::mpsc::{Receiver, Sender}; diff --git a/satrs-core/tests/pus_autogen_events.rs b/satrs/tests/pus_autogen_events.rs similarity index 99% rename from satrs-core/tests/pus_autogen_events.rs rename to satrs/tests/pus_autogen_events.rs index eaec7e6..4aced1d 100644 --- a/satrs-core/tests/pus_autogen_events.rs +++ b/satrs/tests/pus_autogen_events.rs @@ -1,6 +1,6 @@ #![allow(dead_code, unused_imports)] -use satrs_core::events::{ +use satrs::events::{ EventU32, EventU32TypedSev, GenericEvent, HasSeverity, LargestEventRaw, LargestGroupIdRaw, Severity, SeverityInfo, SeverityLow, SeverityMedium, }; diff --git a/satrs-core/tests/pus_events.rs b/satrs/tests/pus_events.rs similarity index 94% rename from satrs-core/tests/pus_events.rs rename to satrs/tests/pus_events.rs index 743d275..dbd778c 100644 --- a/satrs-core/tests/pus_events.rs +++ b/satrs/tests/pus_events.rs @@ -1,13 +1,11 @@ -use satrs_core::event_man::{ +use satrs::event_man::{ EventManagerWithMpscQueue, MpscEventU32Receiver, MpscEventU32SendProvider, SendEventProvider, }; -use satrs_core::events::{EventU32, EventU32TypedSev, Severity, SeverityInfo}; -use satrs_core::params::U32Pair; -use satrs_core::params::{Params, ParamsHeapless, WritableToBeBytes}; -use satrs_core::pus::event_man::{ - DefaultPusMgmtBackendProvider, EventReporter, PusEventDispatcher, -}; -use satrs_core::pus::MpscTmAsVecSender; +use satrs::events::{EventU32, EventU32TypedSev, Severity, SeverityInfo}; +use satrs::params::U32Pair; +use satrs::params::{Params, ParamsHeapless, WritableToBeBytes}; +use satrs::pus::event_man::{DefaultPusMgmtBackendProvider, EventReporter, PusEventDispatcher}; +use satrs::pus::MpscTmAsVecSender; use spacepackets::ecss::tm::PusTmReader; use spacepackets::ecss::{PusError, PusPacket}; use std::sync::mpsc::{channel, SendError, TryRecvError}; diff --git a/satrs-core/tests/pus_verification.rs b/satrs/tests/pus_verification.rs similarity index 97% rename from satrs-core/tests/pus_verification.rs rename to satrs/tests/pus_verification.rs index 84a105c..bc52d6f 100644 --- a/satrs-core/tests/pus_verification.rs +++ b/satrs/tests/pus_verification.rs @@ -1,14 +1,12 @@ //#[cfg(feature = "crossbeam")] pub mod crossbeam_test { use hashbrown::HashMap; - use satrs_core::pool::{ - PoolProvider, PoolProviderWithGuards, StaticMemoryPool, StaticPoolConfig, - }; - use satrs_core::pus::verification::{ + use satrs::pool::{PoolProvider, PoolProviderWithGuards, StaticMemoryPool, StaticPoolConfig}; + use satrs::pus::verification::{ FailParams, RequestId, VerificationReporterCfg, VerificationReporterWithSender, }; - use satrs_core::pus::CrossbeamTmInStoreSender; - use satrs_core::tmtc::tm_helper::SharedTmPool; + use satrs::pus::CrossbeamTmInStoreSender; + use satrs::tmtc::tm_helper::SharedTmPool; use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader}; use spacepackets::ecss::tm::PusTmReader; use spacepackets::ecss::{EcssEnumU16, EcssEnumU8, PusPacket, WritablePusPacket}; diff --git a/satrs-core/tests/tcp_servers.rs b/satrs/tests/tcp_servers.rs similarity index 99% rename from satrs-core/tests/tcp_servers.rs rename to satrs/tests/tcp_servers.rs index e5297c3..b960df7 100644 --- a/satrs-core/tests/tcp_servers.rs +++ b/satrs/tests/tcp_servers.rs @@ -22,7 +22,7 @@ use std::{ }; use hashbrown::HashSet; -use satrs_core::{ +use satrs::{ encoding::cobs::encode_packet_with_cobs, hal::std::tcp_server::{ServerConfig, TcpSpacepacketsServer, TcpTmtcInCobsServer}, tmtc::{ReceivesTcCore, TmPacketSourceCore}, -- 2.43.0