telemetry_manager.h

[詳解]

 
#ifndef TELEMETRY_MANAGER_H_
#define TELEMETRY_MANAGER_H_
 
#include "../System/ApplicationManager/app_info.h"
#include "../TlmCmd/common_cmd_packet.h"
#include "../TlmCmd/common_cmd_packet_util.h"
#include "../TlmCmd/block_command_table.h"
#include <src_user/TlmCmd/telemetry_definitions.h>
#include <src_user/Settings/TlmCmd/Ccsds/apid_define.h>
 
 
// 以下がともに 10 であることで， 10 x 10 x cycle で 10 秒周期に最大 100 個の tlm を登録できる．
#define TLM_MGR_USE_BC_NUM            (10)    
#define TLM_MGR_MAX_CMD_NUM_PER_BC    (10)    
 
#if BCT_MAX_CMD_NUM < TLM_MGR_MAX_CMD_NUM_PER_BC       // FIXME: BCT 側が直ったらなおす
#error BCT_MAX_CMD_NUM is not enough for TelemetryManager
#endif
 
 
typedef enum
{
  TLM_MGR_ERR_CODE_OK,
  TLM_MGR_ERR_CODE_CMD_FULL,          
  TLM_MGR_ERR_CODE_CMD_NOT_FOUND,     
  TLM_MGR_ERR_CODE_INVALID_BC_ROLE,   
  TLM_MGR_ERR_CODE_INVALID_CMD_TYPE,  
  TLM_MGR_ERR_CODE_BCT_ERR,           
  TLM_MGR_ERR_CODE_OTHER_ERR          
} TLM_MGR_ERR_CODE;
 
 
typedef enum
{
  TLM_MGR_BC_ROLE_HK_TLM,             
  TLM_MGR_BC_ROLE_HIGH_FREQ_TLM,      
  TLM_MGR_BC_ROLE_LOW_FREQ_TLM        
} TLM_MGR_BC_ROLE;
 
 
typedef enum
{
  TLM_MGR_CMD_TYPE_UNREGISTERED = 0,   
  TLM_MGR_CMD_TYPE_TG_GENERATE_RT_TLM,
  TLM_MGR_CMD_TYPE_TG_GENERATE_ST_TLM,
  TLM_MGR_CMD_TYPE_TG_FORWARD_AS_RT_TLM,
  TLM_MGR_CMD_TYPE_TG_FORWARD_AS_ST_TLM,
  TLM_MGR_CMD_TYPE_DR_REPLAY_TLM
} TLM_MGR_CMD_TYPE;
 
 
typedef struct
{
  uint8_t cmd_table_idxes[TLM_MGR_USE_BC_NUM];  
  uint8_t cmd_table_idxes_size;                 
  uint8_t registered_cmd_num;                   
} TLM_MGR_RegisterInfo;
 
 
typedef struct
{
  TLM_MGR_CMD_TYPE cmd_type;      
  APID             apid;          
  TLM_CODE         tlm_id;        
  uint8_t          dr_partition;  
} TLM_MGR_CmdElem;
 
 
typedef struct
{
  TLM_MGR_CmdElem cmds[TLM_MGR_MAX_CMD_NUM_PER_BC];
  bct_id_t        bc_id;            
  TLM_MGR_BC_ROLE bc_role;          
} TLM_MGR_CmdBlock;
 
 
typedef struct
{
  TLM_MGR_CmdBlock cmd_blocks[TLM_MGR_USE_BC_NUM];      
} TLM_MGR_CmdTable;
 
 
typedef struct
{
  struct
  {
    TLM_MGR_RegisterInfo hk;          
    TLM_MGR_RegisterInfo high_freq;   
    TLM_MGR_RegisterInfo low_freq;    
  } register_info;
  TLM_MGR_CmdTable cmd_table;         
  bct_id_t master_bc_id;              
  bct_id_t deploy_bc_id;              
  uint8_t is_inited;                  
} TelemetryManager;
 
 
extern const TelemetryManager* const telemetry_manager;
 
AppInfo TLM_MGR_create_app(void);
 
 
CCP_CmdRet Cmd_TLM_MGR_INIT(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_INIT_MASTER_AND_DEPLOY_BC(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_CLEAR_HK_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_CLEAR_HIGH_FREQ_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_CLEAR_LOW_FREQ_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_CLEAR_USER_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_START_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_STOP_TLM(const CommonCmdPacket* packet);
 
// 以下，コマンド登録コマンド
CCP_CmdRet Cmd_TLM_MGR_REGISTER_GENERATE_RT_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_REGISTER_GENERATE_ST_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_REGISTER_FORWARD_AS_RT_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_REGISTER_FORWARD_AS_ST_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_REGISTER_REPLAY_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_TLM_MGR_DELETE_GENERATE_RT_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_DELETE_GENERATE_ST_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_DELETE_FORWARD_AS_RT_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_DELETE_FORWARD_AS_ST_TLM(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_TLM_MGR_DELETE_REPLAY_TLM(const CommonCmdPacket* packet);
 
// TODO: いきなり設定が変わるのではなく，設定変更 → 反映，にしたい．
// CCP_CmdRet Cmd_TLM_MGR_APPLY(const CommonCmdPacket* packet);
 
 
// *** HOW TO USE ***
/*
1. 初期化：Cmd_TLM_MGR_INIT
  - BCをいじるため，Appの初期化では現時点でできないので，明示的に初期化する必要あり
    - initial SLにいれてもいいかも． DCU を使ってるので， 1 秒ほどかかる
2. 非ユーザーテレメの登録
  - HK TLMを登録しておく ( Cmd_TLM_MGR_REGISTER_HOGE で )
3. テレメ送出開始
  - Cmd_TLM_MGR_START_TLM にてテレメ送出開始
    - 止めるのは Cmd_TLM_MGR_STOP_TLM
4. Cmd_TLM_MGR_REGISTER_HOGE にて，1 Hz, 1/10 Hz のユーザーテレメを各人が好きに登録できる
5. 試験などが終わったら Cmd_TLM_MGR_CLEAR_USER_TLM をして，ユーザーテレメを消す
6. 次に使う人がいたら，4.から繰り返す
7. Cmd_TLM_MGR_DELETE_HOGE で登録したコマンドを指定して削除可能
*/
 
#endif