Skip to content
Snippets Groups Projects
Commit e7ddde7f authored by thodkatz's avatar thodkatz
Browse files

Better documentation

parent 84d4f5e5
No related branches found
No related tags found
No related merge requests found
...@@ -5,12 +5,13 @@ ...@@ -5,12 +5,13 @@
#include "Helpers/TimeHelper.hpp" #include "Helpers/TimeHelper.hpp"
/** /**
* Implementation of the ST[09] time management implementation * Implementation of the ST[09] time management. The current implementation sends
* a report with the spacecraft time that is formatted according to the CUC time code format
* (check TimeHelper for the format)
* *
* @todo When the time comes for the application processes we should consider this: All reports * @todo When the time comes for the application processes we should consider this: All reports
* generated by the application process that is identified by APID 0 are time reports. * generated by the application process that is identified by APID 0 are time reports
* @todo check if we need to implement the time reporting control subservice * @todo Declare the time accuracy that the standard claims in the spacecraft
* @todo check if we need to declare the time accuracy that the standard claims in the spacecraft
* time reference section(6.9.3.d,e) * time reference section(6.9.3.d,e)
*/ */
class TimeManagementService : public Service { class TimeManagementService : public Service {
...@@ -22,11 +23,12 @@ public: ...@@ -22,11 +23,12 @@ public:
/** /**
* @param seconds the seconds provided from the RTC. This function in general should have * @param seconds the seconds provided from the RTC. This function in general should have
* parameters corresponding with the RTC. For the time being we assume that the RTC has a * parameters corresponding with the RTC. For the time being we assume that the RTC has a
* 32-bit counter that counts seconds(the RTC in Nucleo F103RB!). * 32-bit counter that counts seconds(the RTC in Nucleo F103RB!)
* @todo check if we need spacecraft time reference status * @todo check if we need spacecraft time reference status
* @todo The time reports generated by the time reporting subservice are spacecraft time * @todo ECSS standard claims: <<The time reports generated by the time reporting subservice
* packets. A spacecraft time packet does not carry the message type, consisting of the * are spacecraft time packets. A spacecraft time packet does not carry the message type,
* service type and message subtype * consisting of the service type and message subtype.>> Check if we need to implement that
* or should ignore the standard?
*/ */
void cucTimeReport(uint32_t seconds); void cucTimeReport(uint32_t seconds);
}; };
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment