Skip to content

Commit b1ad607

Browse files
ineskhouineskhou
committed
appease linter
1 parent 488b01c commit b1ad607

File tree

6 files changed

+219
-0
lines changed

6 files changed

+219
-0
lines changed

‎FprimeZephyrReference/Components/AntennaDeployer/AntennaDeployer.cpp‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// ======================================================================
2+
// \title AntennaDeployer.cpp
3+
// \author aldjia
4+
// \brief cpp file for AntennaDeployer component implementation class
5+
// ======================================================================
6+
7+
#include "FprimeZephyrReference/Components/AntennaDeployer/AntennaDeployer.hpp"
8+
9+
namespace Components {
10+
11+
// ----------------------------------------------------------------------
12+
// Component construction and destruction
13+
// ----------------------------------------------------------------------
14+
15+
AntennaDeployer ::AntennaDeployer(const char* const compName) : AntennaDeployerComponentBase(compName) {}
16+
17+
AntennaDeployer ::~AntennaDeployer() {}
18+
19+
} // namespace Components

‎FprimeZephyrReference/Components/AntennaDeployer/AntennaDeployer.fpp‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
module Components {
2+
@ Component that deploys the antenna, activates the burnwire, checks the distance sensor
3+
passive component AntennaDeployer {
4+
5+
##############################################################################
6+
#### Uncomment the following examples to start customizing your component ####
7+
##############################################################################
8+
9+
# @ Example async command
10+
# async command COMMAND_NAME(param_name: U32)
11+
12+
# @ Example telemetry counter
13+
# telemetry ExampleCounter: U64
14+
15+
# @ Example event
16+
# event ExampleStateEvent(example_state: Fw.On) severity activity high id 0 format "State set to {}"
17+
18+
# @ Example port: receiving calls from the rate group
19+
# sync input port run: Svc.Sched
20+
21+
# @ Example parameter
22+
# param PARAMETER_NAME: U32
23+
24+
###############################################################################
25+
# Standard AC Ports: Required for Channels, Events, Commands, and Parameters #
26+
###############################################################################
27+
@ Port for requesting the current time
28+
time get port timeCaller
29+
30+
@ Port for sending command registrations
31+
command reg port cmdRegOut
32+
33+
@ Port for receiving commands
34+
command recv port cmdIn
35+
36+
@ Port for sending command responses
37+
command resp port cmdResponseOut
38+
39+
@ Port for sending textual representation of events
40+
text event port logTextOut
41+
42+
@ Port for sending events to downlink
43+
event port logOut
44+
45+
@ Port for sending telemetry channels to downlink
46+
telemetry port tlmOut
47+
48+
@ Port to return the value of a parameter
49+
param get port prmGetOut
50+
51+
@Port to set the value of a parameter
52+
param set port prmSetOut
53+
54+
}
55+
}

‎FprimeZephyrReference/Components/AntennaDeployer/AntennaDeployer.hpp‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// ======================================================================
2+
// \title AntennaDeployer.hpp
3+
// \author aldjia
4+
// \brief hpp file for AntennaDeployer component implementation class
5+
// ======================================================================
6+
7+
#ifndef Components_AntennaDeployer_HPP
8+
#define Components_AntennaDeployer_HPP
9+
10+
#include "FprimeZephyrReference/Components/AntennaDeployer/AntennaDeployerComponentAc.hpp"
11+
12+
namespace Components {
13+
14+
class AntennaDeployer final : public AntennaDeployerComponentBase {
15+
public:
16+
// ----------------------------------------------------------------------
17+
// Component construction and destruction
18+
// ----------------------------------------------------------------------
19+
20+
//! Construct AntennaDeployer object
21+
AntennaDeployer(const char* const compName //!< The component name
22+
);
23+
24+
//! Destroy AntennaDeployer object
25+
~AntennaDeployer();
26+
};
27+
28+
} // namespace Components
29+
30+
#endif

‎FprimeZephyrReference/Components/AntennaDeployer/CMakeLists.txt‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
####
2+
# F Prime CMakeLists.txt:
3+
#
4+
# SOURCES: list of source files (to be compiled)
5+
# AUTOCODER_INPUTS: list of files to be passed to the autocoders
6+
# DEPENDS: list of libraries that this module depends on
7+
#
8+
# More information in the F´ CMake API documentation:
9+
# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
10+
#
11+
####
12+
13+
# Module names are derived from the path from the nearest project/library/framework
14+
# root when not specifically overridden by the developer. i.e. The module defined by
15+
# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.
16+
17+
register_fprime_library(
18+
AUTOCODER_INPUTS
19+
"${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer.fpp"
20+
SOURCES
21+
"${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer.cpp"
22+
# DEPENDS
23+
# MyPackage_MyOtherModule
24+
)
25+
26+
### Unit Tests ###
27+
# register_fprime_ut(
28+
# AUTOCODER_INPUTS
29+
# "${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer.fpp"
30+
# SOURCES
31+
# "${CMAKE_CURRENT_LIST_DIR}/test/ut/AntennaDeployerTestMain.cpp"
32+
# "${CMAKE_CURRENT_LIST_DIR}/test/ut/AntennaDeployerTester.cpp"
33+
# DEPENDS
34+
# STest # For rules-based testing
35+
# UT_AUTO_HELPERS
36+
# )

‎FprimeZephyrReference/Components/AntennaDeployer/docs/sdd.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Components::AntennaDeployer
2+
3+
Component that deploys the antenna, activates the burnwire, checks the distance sensor
4+
5+
6+
## Requirements
7+
Add requirements in the chart below
8+
| Name | Description | Validation |
9+
|---|---|---|
10+
|AD0001|The Antenna Deployer shall have a wait period attached to the rate group to deloy antenna after quiet time following antenna deployment | Unit Testing|
11+
|AD0002|The Antenna Deployer shall attempt to redeploy the burnwire if the distance sensor senses the antenna is not deployed | Unit Testing|
12+
|AD0003|The Antenna Deployer shall attempt to deploy if the distance sensor disconnects |Unit Testing|
13+
|AD0004|The Antenna Deployer shall broadcast an event every time it tries to deploy | Unit Testing|
14+
|AD0005|The Antenna Deployer shall broadcast an event when it successfully deploys | Unit Testing|
15+
|AD0006|The Antenna Deployer shall carry a count of the amount of times it has tried to deploy | Unit Testing|
16+
17+
18+
## Usage Examples
19+
Add usage examples here
20+
21+
### Diagrams
22+
Add diagrams here
23+
24+
### Typical Usage
25+
And the typical usage of the component here
26+
27+
## Class Diagram
28+
Add a class diagram here
29+
30+
## Port Descriptions
31+
| Name | Description |
32+
|---|---|
33+
|---|---|
34+
35+
## Component States
36+
Add component states in the chart below
37+
| Name | Description |
38+
|deploy_count|Keeps track of how many deploys happened |
39+
|---|---|
40+
41+
## Sequence Diagrams
42+
Add sequence diagrams here
43+
44+
## Parameters
45+
| Name | Description |
46+
|---|---|
47+
|---|---|
48+
49+
## Commands
50+
| Name | Description |
51+
| ---- | ----------- |
52+
|DEPLOY|Starts deployment procedure|
53+
|DEPLOY_STOP|Stops deployment procedure|
54+
55+
56+
## Events
57+
| Name | Description |
58+
|Deploy_Attempt|Emitted when deploy attempt starts|
59+
|Deploy_Sucess|Emitted once the antenna has been detected as successfully deployed|
60+
|Deploy_Finish|Emitted once deploy attempts are finished|
61+
62+
63+
## Telemetry
64+
| Name | Description |
65+
|---|---|
66+
|---|---|
67+
68+
## Unit Tests
69+
Add unit test descriptions in the chart below
70+
| Name | Description | Output | Coverage |
71+
|---|---|---|---|
72+
|---|---|---|---|
73+
74+
75+
## Change Log
76+
| Date | Description |
77+
|---|---|
78+
|---| Initial Draft |

‎FprimeZephyrReference/Components/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FatalHandler")
44
add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Watchdog")
55
add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")
6+
add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer/")

0 commit comments

Comments
 (0)