Implementation of the offsets in the RateGroupDriver #2166

SMorettini · 2023-08-01T06:44:34Z


*Originating Project/Creator*
*Affected Component*	Svc.RateGroupDriver
*Affected Architectures(s)*
*Related Issue(s)*	#2135
*Has Unit Tests (y/n)*	y
*Builds Without Errors (y/n)*	y
*Unit Tests Pass (y/n)*	y
*Documentation Included (y/n)*	y

Change Description

This pull request adds the possibility to define some offset in the RateGroupDriver. This pull request was first created here but never merged. An issue was reopened here.

I apply the changes suggested in the previous pull request with the suggested changes from the reviewer @LeStarch .

csmith608 · 2023-08-02T03:38:17Z

@SMorettini upon initial inspection this looks good, thanks so much for (hopefully) taking it across the finish line

Svc/RateGroupDriver/RateGroupDriver.hpp

Svc/RateGroupDriver/RateGroupDriver.cpp

LeStarch · 2023-08-14T20:48:03Z

@SMorettini you should make sure to update the RPI deployment as well. This is the source of the code break.

Also, "No raw arrays in interfaces" is caused because you created an array of Dividers. To fix you could create a type called DividerSet, which is:

struct DivisderSet {
   Divider dividers[Svc::RateGroupDriver::DIVIDER_SIZE];
}

I'd prefer it if you'd make that adjustment as this was what we were trying to adjust last time.

LeStarch

Made some comments in the discussion. Let me know what you'd do and we'll pick-up the rest.

…e-group

SMorettini · 2023-09-17T16:11:09Z

@LeStarch I added the changes requested, let me know if some other improvements are required.

I also created a pull request to update the Led blinker tutorial to work with the new RateGroupDriver dividers: fprime-community/fprime-workshop-led-blinker#41

Svc/RateGroupDriver/RateGroupDriver.hpp

@@ -33,6 +33,24 @@
    class RateGroupDriver : public RateGroupDriverComponentBase {

        public:
+            //! Size of the divider table, provided as a constants to users passing the table in
+            static const NATIVE_UINT_TYPE DIVIDER_SIZE = NUM_CYCLEOUT_OUTPUT_PORTS;


Svc/RateGroupDriver/RateGroupDriver.hpp

+                //! Divisor
+                NATIVE_INT_TYPE divisor;
+                //! Offset
+                NATIVE_INT_TYPE offset;


Svc/RateGroupDriver/RateGroupDriver.hpp

+            //! \brief Struct describing a divider
+            struct Divider{
+                //! Divisor
+                NATIVE_INT_TYPE divisor;


Svc/RateGroupDriver/RateGroupDriver.cpp

LeStarch · 2023-10-12T01:55:08Z

I made some changes here:

Added constructors to DivisorSet to guarantee when not explicitly initialized, that that pair was set to zero
Removed argument "numDivisors" as when we transitioned to a set, this resulted in it being a constant.

Need to let CI run, but otherwise ready to go!

Svc/RateGroupDriver/RateGroupDriver.hpp

+                //! Initializes divisor and offset to passed-in pair 
+                Divider(NATIVE_INT_TYPE divisorIn, NATIVE_INT_TYPE offsetIn) :
+                    divisor(divisorIn), offset(offsetIn)
+                {}


Svc/RateGroupDriver/RateGroupDriver.hpp

+            struct Divider{
+                //! Initializes divisor and offset to 0 (unused)
+                Divider() : divisor(0), offset(0)
+                {}


Svc/RateGroupDriver/RateGroupDriver.cpp

Svc/RateGroupDriver/RateGroupDriver.hpp

+                Divider() : divisor(0), offset(0)
+                {}
+                //! Initializes divisor and offset to passed-in pair 
+                Divider(NATIVE_INT_TYPE divisorIn, NATIVE_INT_TYPE offsetIn) :


Svc/RateGroupDriver/RateGroupDriver.hpp

+                Divider() : divisor(0), offset(0)
+                {}
+                //! Initializes divisor and offset to passed-in pair 
+                Divider(NATIVE_INT_TYPE divisorIn, NATIVE_INT_TYPE offsetIn) :


Svc/RateGroupDriver/RateGroupDriver.cpp

        // copy provided array of dividers
-        for (NATIVE_INT_TYPE entry = 0; entry < numDividers; entry++) {
-            this->m_dividers[entry] = dividers[entry];
+        for (NATIVE_UINT_TYPE entry = 0; entry < RateGroupDriver::DIVIDER_SIZE; entry++) {


timcanham

Approve but with a general question about init() calls...

Svc/RateGroupDriver/RateGroupDriver.hpp

LeStarch · 2023-10-24T21:16:21Z

@thomas-bc: core component, would you be a second set of 👀 ?

Svc/RateGroupDriver/RateGroupDriver.cpp


    }

-    void RateGroupDriver::configure(NATIVE_INT_TYPE dividers[], NATIVE_INT_TYPE numDividers)
+    void RateGroupDriver::configure(const DividerSet& dividerSet)


Svc/RateGroupDriver/RateGroupDriver.hpp

-            static const NATIVE_UINT_TYPE DIVIDER_SIZE = NUM_CYCLEOUT_OUTPUT_PORTS;
+
+            //! has the configure method been called
+            bool m_configured;


Svc/RateGroupDriver/RateGroupDriver.cpp


        // Loop through each divider. For a given port, the port will be called when the divider value
        // divides evenly into the number of ticks. For example, if the divider value for a port is 4,
        // it would be called every fourth invocation of the CycleIn port.
-        for (NATIVE_INT_TYPE entry = 0; entry < this->m_numDividers; entry++) {
-            if (this->m_dividers[entry] != 0) {
+        for (NATIVE_UINT_TYPE entry = 0; entry < RateGroupDriver::DIVIDER_SIZE; entry++) {


thomas-bc

🚀

LeStarch

Approved! Thanks for the fixes!

Co-authored-by: M Starch <[email protected]>

* Add support for new rate group dividers (#41) * Add support for new rate group dividers * Fix naming mistake * Fixing topology for nasa/fprime#2166 --------- Co-authored-by: Simone Morettini <[email protected]> Co-authored-by: M Starch <[email protected]>

Implementation of the offsets

1a0ec2b

SMorettini mentioned this pull request Aug 1, 2023

Add offset option for rate groups allowing different trigger patterns #2135

Closed

SMorettini changed the title ~~Implementation of the offsets~~ Implementation of the offsets in the RateGroupDriver Aug 1, 2023

Fix comment

8250b04

Fix spell error

36abd46

github-advanced-security bot found potential problems Aug 2, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.hpp Fixed Show fixed Hide fixed

Svc/RateGroupDriver/RateGroupDriver.hpp Fixed Show fixed Hide fixed

Svc/RateGroupDriver/RateGroupDriver.cpp Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Aug 2, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.cpp Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Aug 2, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.cpp Fixed Show fixed Hide fixed

LeStarch self-requested a review August 14, 2023 20:49

LeStarch requested changes Aug 14, 2023

View reviewed changes

Simone Morettini added 3 commits September 17, 2023 09:49

Merge remote-tracking branch 'origin/devel' into adding-offset-to-rat…

9d4251b

…e-group

Changing configure interface by addind DividersSet

a33a79e

Update RPI topology

ddeae62

SMorettini mentioned this pull request Sep 17, 2023

Add support for new rate group dividers fprime-community/fprime-workshop-led-blinker#41

Merged

github-advanced-security bot found potential problems Sep 19, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.cpp Fixed Show fixed Hide fixed

LeStarch added the Update Instructions Needed Need to add instructions in the release notes for updates. label Oct 12, 2023

Removing numDivisors from call

306d7bc

LeStarch requested review from LeStarch, thomas-bc and timcanham October 12, 2023 01:55

Removing memset clear as the constructor handles zeroed initialization

c262890

github-advanced-security bot found potential problems Oct 12, 2023

View reviewed changes

LeStarch added a commit to fprime-community/fprime-tutorial-hello-world that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

1fd34dc

LeStarch added a commit to fprime-community/fprime-tutorial-math-component that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

17c1012

LeStarch added a commit to fprime-community/fprime-tutorial-hello-world that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

3af431d

LeStarch added a commit to fprime-community/fprime-workshop-led-blinker that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

a770956

LeStarch added a commit to fprime-community/fprime-tutorial-hello-world that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

3e476d7

LeStarch added a commit to fprime-community/fprime-tutorial-math-component that referenced this pull request Oct 12, 2023

Fixing topology for nasa/fprime#2166

69523e7

timcanham approved these changes Oct 12, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.hpp Show resolved Hide resolved

thomas-bc reviewed Oct 26, 2023

View reviewed changes

Svc/RateGroupDriver/RateGroupDriver.cpp Outdated Show resolved Hide resolved

LeStarch added 2 commits October 26, 2023 12:28

Fixing ASSERT and removing m_numDivisors

2766808

Renaming divisersSet to diviserSet

436912b

github-advanced-security bot found potential problems Oct 26, 2023

View reviewed changes

timcanham approved these changes Oct 26, 2023

View reviewed changes

LeStarch added a commit to fprime-community/fprime-tutorial-hello-world that referenced this pull request Oct 26, 2023

Fixing topology for nasa/fprime#2166

b9ee211

LeStarch added a commit to fprime-community/fprime-tutorial-math-component that referenced this pull request Oct 26, 2023

Fixing topology for nasa/fprime#2166

5a3c270

LeStarch added a commit to fprime-community/fprime-workshop-led-blinker that referenced this pull request Oct 26, 2023

Fixing topology for nasa/fprime#2166

4182fab

thomas-bc approved these changes Oct 26, 2023

View reviewed changes

LeStarch approved these changes Oct 26, 2023

View reviewed changes

LeStarch merged commit 36a07dd into nasa:devel Oct 26, 2023
34 checks passed

thomas-bc mentioned this pull request Oct 26, 2023

RateGroupDriver offset changes for nasa/fprime#2166 fprime-community/fprime-workshop-led-blinker#52

Merged

thomas-bc added a commit to fprime-community/fprime-tutorial-hello-world that referenced this pull request Oct 26, 2023

RateGroupDriver offset changes for nasa/fprime#2166 (#10)

bbfc992

Co-authored-by: M Starch <[email protected]>

thomas-bc added a commit to fprime-community/fprime-tutorial-math-component that referenced this pull request Oct 26, 2023

RateGroupDriver offset changes for nasa/fprime#2166 (#19)

4b89b9d

Co-authored-by: M Starch <[email protected]>

thomas-bc mentioned this pull request Nov 28, 2023

Update deployment cookiecutter nasa/fprime-tools#179

Merged

SMorettini deleted the adding-offset-to-rate-group branch February 6, 2024 07:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation of the offsets in the RateGroupDriver #2166

Implementation of the offsets in the RateGroupDriver #2166

SMorettini commented Aug 1, 2023

csmith608 commented Aug 2, 2023

LeStarch commented Aug 14, 2023

LeStarch left a comment

SMorettini commented Sep 17, 2023

LeStarch commented Oct 12, 2023

timcanham left a comment

LeStarch commented Oct 24, 2023

thomas-bc left a comment

LeStarch left a comment

Implementation of the offsets in the RateGroupDriver #2166

Implementation of the offsets in the RateGroupDriver #2166

Conversation

SMorettini commented Aug 1, 2023

Change Description

csmith608 commented Aug 2, 2023

LeStarch commented Aug 14, 2023

LeStarch left a comment

Choose a reason for hiding this comment

SMorettini commented Sep 17, 2023

LeStarch commented Oct 12, 2023

timcanham left a comment

Choose a reason for hiding this comment

LeStarch commented Oct 24, 2023

thomas-bc left a comment

Choose a reason for hiding this comment

LeStarch left a comment

Choose a reason for hiding this comment