mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 04:35:25 -06:00
b7a25920a3
* manual packet gen * Added tlmPkt to deployment * Packet files * Fixes to packet gen script * format python, updated packet files * spelling fixes * integrating packet autocoder * final updates for telemetry packetization * formatting telemetry packetizer cpde * moving tlm packetizer configuration file * resetting stock telemetry channelizer * missed packetizer setup call * fixing autocoding miss-match with Svc::TlmChan Co-authored-by: M Starch <LeStarch@googlemail.com>
98 lines
2.8 KiB
C++
98 lines
2.8 KiB
C++
// ======================================================================
|
|
// \title RefTopologyDefs.hpp
|
|
// \author mstarch
|
|
// \brief required header file containing the required definitions for the topology autocoder
|
|
//
|
|
// \copyright
|
|
// Copyright 2009-2022, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
// ======================================================================
|
|
#ifndef REF_REFTOPOLOGYDEFS_HPP
|
|
#define REF_REFTOPOLOGYDEFS_HPP
|
|
|
|
#include "Drv/BlockDriver/BlockDriver.hpp"
|
|
#include "Fw/Types/MallocAllocator.hpp"
|
|
#include "Ref/Top/FppConstantsAc.hpp"
|
|
#include "Svc/FramingProtocol/FprimeProtocol.hpp"
|
|
#include "Svc/Health/Health.hpp"
|
|
|
|
// Definitions are placed within a namespace named after the deployment
|
|
namespace Ref {
|
|
|
|
/**
|
|
* \brief required type definition to carry state
|
|
*
|
|
* The topology autocoder requires an object that carries state with the name `Ref::TopologyState`. Only the type
|
|
* definition is required by the autocoder and the contents of this object are otherwise opaque to the autocoder. The
|
|
* contents are entirely up to the definition of the project. This reference application specifies hostname and port
|
|
* fields, which are derived by command line inputs.
|
|
*/
|
|
struct TopologyState {
|
|
const char* hostname;
|
|
U32 port;
|
|
};
|
|
|
|
/**
|
|
* \brief required ping constants
|
|
*
|
|
* The topology autocoder requires a WARN and FATAL constant definition for each component that supports the health-ping
|
|
* interface. These are expressed as enum constants placed in a namespace named for the component instance. These
|
|
* are all placed in the PingEntries namespace.
|
|
*
|
|
* Each constant specifies how many missed pings are allowed before a WARNING_HI/FATAL event is triggered. In the
|
|
* following example, the health component will emit a WARNING_HI event if the component instance cmdDisp does not
|
|
* respond for 3 pings and will FATAL if responses are not received after a total of 5 pings.
|
|
*
|
|
* ```c++
|
|
* namespace PingEntries {
|
|
* namespace cmdDisp {
|
|
* enum { WARN = 3, FATAL = 5 };
|
|
* }
|
|
* }
|
|
* ```
|
|
*/
|
|
namespace PingEntries {
|
|
namespace blockDrv {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace tlmSend {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace cmdDisp {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace cmdSeq {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace eventLogger {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace fileDownlink {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace fileManager {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace fileUplink {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace pingRcvr {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace prmDb {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace rateGroup1Comp {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace rateGroup2Comp {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
namespace rateGroup3Comp {
|
|
enum { WARN = 3, FATAL = 5 };
|
|
}
|
|
} // namespace PingEntries
|
|
} // namespace Ref
|
|
#endif
|