Initial Component Design

Author: RobertPendergrast

FprimeZephyrReference/Components/CMakeLists.txt

@@ -10,3 +10,4 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/BootloaderTrigger/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FsSpace/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/CameraManager/")

FprimeZephyrReference/Components/CameraManager/CMakeLists.txt

@@ -0,0 +1,36 @@
+####
+# F Prime CMakeLists.txt:
+#
+# SOURCES: list of source files (to be compiled)
+# AUTOCODER_INPUTS: list of files to be passed to the autocoders
+# DEPENDS: list of libraries that this module depends on
+#
+# More information in the F´ CMake API documentation:
+# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
+#
+####
+
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer. i.e. The module defined by
+# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.
+
+register_fprime_library(
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/CameraManager.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/CameraManager.cpp"
+#   DEPENDS
+#       MyPackage_MyOtherModule
+)
+
+### Unit Tests ###
+# register_fprime_ut(
+#     AUTOCODER_INPUTS
+#         "${CMAKE_CURRENT_LIST_DIR}/CameraManager.fpp"
+#     SOURCES
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/CameraManagerTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/CameraManagerTester.cpp"
+#     DEPENDS
+#         STest # For rules-based testing
+#     UT_AUTO_HELPERS
+# )

FprimeZephyrReference/Components/CameraManager/CameraManager.cpp

@@ -0,0 +1,39 @@
+// ======================================================================
+// \title  CameraManager.cpp
+// \author robertpendergrast
+// \brief  cpp file for CameraManager component implementation class
+// ======================================================================
+
+#include "FprimeZephyrReference/Components/CameraManager/CameraManager.hpp"
+
+namespace FprimeZephyrReference {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+CameraManager ::CameraManager(const char* const compName) : CameraManagerComponentBase(compName) {}
+
+CameraManager ::~CameraManager() {}
+
+// ----------------------------------------------------------------------
+// Handler implementations for commands
+// ----------------------------------------------------------------------
+
+void CameraManager ::TAKE_IMAGE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
+    // Prepare the "snap" command to send over UART via out_port
+    Fw::Buffer snapBuffer(0, reinterpret_cast<U64>(snap_cmd), sizeof(snap_cmd) - 1); // exclude null terminator
+    // Send the buffer via out_port, check/send status if needed
+    Drv::ByteStreamStatus sendStatus = this->out_port_out(0, snapBuffer);
+    if (sendStatus != Drv::ByteStreamStatus::OP_OK) {
+        this->log_WARNING_HI_TakeImageError();
+        this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::EXECUTION_ERROR);
+        return;
+    }
+    else {
+        this->log_ACTIVITY_HI_PictureTaken();
+    }
+    this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+}
+
+}  // namespace FprimeZephyrReference

FprimeZephyrReference/Components/CameraManager/CameraManager.fpp

@@ -0,0 +1,66 @@
+module FprimeZephyrReference {
+    @ Manager for Nicla Vision
+    active component CameraManager {
+
+        # One async command/port is required for active components
+        # This should be overridden by the developers with a useful command/port
+        @ TODO
+        async command TAKE_IMAGE
+
+        event TakeImageError() severity warning high format "Failed to take picture"
+
+        event PictureTaken() severity activity high format "Picture Taken"
+
+        output port out_port: Drv.ByteStreamSend
+
+        ##############################################################################
+        #### Uncomment the following examples to start customizing your component ####
+        ##############################################################################
+
+        # @ Example async command
+        # async command COMMAND_NAME(param_name: U32)
+
+        # @ Example telemetry counter
+        # telemetry ExampleCounter: U64
+
+        # @ Example event
+        # event ExampleStateEvent(example_state: Fw.On) severity activity high id 0 format "State set to {}"
+
+        # @ Example port: receiving calls from the rate group
+        # sync input port run: Svc.Sched
+
+        # @ Example parameter
+        # param PARAMETER_NAME: U32
+
+        ###############################################################################
+        # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #
+        ###############################################################################
+        @ Port for requesting the current time
+        time get port timeCaller
+
+        @ Port for sending command registrations
+        command reg port cmdRegOut
+
+        @ Port for receiving commands
+        command recv port cmdIn
+
+        @ Port for sending command responses
+        command resp port cmdResponseOut
+
+        @ Port for sending textual representation of events
+        text event port logTextOut
+
+        @ Port for sending events to downlink
+        event port logOut
+
+        @ Port for sending telemetry channels to downlink
+        telemetry port tlmOut
+
+        @ Port to return the value of a parameter
+        param get port prmGetOut
+
+        @Port to set the value of a parameter
+        param set port prmSetOut
+
+    }
+}

FprimeZephyrReference/Components/CameraManager/CameraManager.hpp

@@ -0,0 +1,44 @@
+// ======================================================================
+// \title  CameraManager.hpp
+// \author robertpendergrast
+// \brief  hpp file for CameraManager component implementation class
+// ======================================================================
+
+#ifndef FprimeZephyrReference_CameraManager_HPP
+#define FprimeZephyrReference_CameraManager_HPP
+
+#include "FprimeZephyrReference/Components/CameraManager/CameraManagerComponentAc.hpp"
+
+namespace FprimeZephyrReference {
+
+class CameraManager final : public CameraManagerComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct CameraManager object
+    CameraManager(const char* const compName  //!< The component name
+    );
+
+    //! Destroy CameraManager object
+    ~CameraManager();
+
+    const char snap_cmd[4] = {'s', 'n', 'a', 'p'};
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for commands
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for command TAKE_IMAGE
+    //!
+    //! TODO
+    void TAKE_IMAGE_cmdHandler(FwOpcodeType opCode,  //!< The opcode
+                               U32 cmdSeq            //!< The command sequence number
+                               ) override;
+};
+
+}  // namespace FprimeZephyrReference
+
+#endif

FprimeZephyrReference/Components/CameraManager/docs/sdd.md

@@ -0,0 +1,66 @@
+# FprimeZephyrReference::CameraManager
+
+Manager for Nicla Vision
+
+## Usage Examples
+Add usage examples here
+
+### Diagrams
+Add diagrams here
+
+### Typical Usage
+And the typical usage of the component here
+
+## Class Diagram
+Add a class diagram here
+
+## Port Descriptions
+| Name | Description |
+|---|---|
+|---|---|
+
+## Component States
+Add component states in the chart below
+| Name | Description |
+|---|---|
+|---|---|
+
+## Sequence Diagrams
+Add sequence diagrams here
+
+## Parameters
+| Name | Description |
+|---|---|
+|---|---|
+
+## Commands
+| Name | Description |
+|---|---|
+|---|---|
+
+## Events
+| Name | Description |
+|---|---|
+|---|---|
+
+## Telemetry
+| Name | Description |
+|---|---|
+|---|---|
+
+## Unit Tests
+Add unit test descriptions in the chart below
+| Name | Description | Output | Coverage |
+|---|---|---|---|
+|---|---|---|---|
+
+## Requirements
+Add requirements in the chart below
+| Name | Description | Validation |
+|---|---|---|
+|---|---|---|
+
+## Change Log
+| Date | Description |
+|---|---|
+|---| Initial Draft |