HK version 2.4.2

Author: ejtimmon

Apache_2_0_GSC-16127-1_CFS_HK.pdf

@@ -1,10 +1,14 @@
 cmake_minimum_required(VERSION 2.6.4)
 project(CFS_HK C)
 
+include_directories(fsw/public_inc)
 include_directories(fsw/mission_inc)
 include_directories(fsw/platform_inc)
+include_directories(fsw/src)
 
 aux_source_directory(fsw/src APP_SRC_FILES)
+aux_source_directory(fsw/tables APP_TABLE_FILES)
 
 # Create the app module
 add_cfe_app(hk ${APP_SRC_FILES})
+add_cfe_tables(hk ${APP_TABLE_FILES})

CMakeLists.txt

@@ -1,15 +1,62 @@
-# Housekeeping
+core Flight System (cFS) Housekeeping Application (HK)
+======================================================
 
-NASA core Flight System Housekeeping Application
+Open Source Release Readme
+==========================
 
-## Description
+HK Release 2.4.2
 
-The Housekeeping application (HK) is a core Flight System (cFS) application that is a plug in to the Core Flight Executive (cFE) component of the cFS.
+Date: 4/17/2020
 
-The cFS is a platform and project independent reusable software framework and set of reusable applications developed by NASA Goddard Space Flight Center. This framework is used as the basis for the flight software for satellite data systems and instruments, but can be used on other embedded systems. More information on the cFS can be found at [http://cfs.gsfc.nasa.gov](http://cfs.gsfc.nasa.gov)
+Introduction
+-------------
+  The Housekeeping application (HK) is a core Flight System (cFS) application
+  that is a plug in to the Core Flight Executive (cFE) component of the cFS.
 
-The HK application is used for building and sending combined telemetry messages (from individual system applications) to the software bus for routing. Combining messages is performed in order to minimize downlink telemetry bandwidth. Combined messages are also useful for organizing certain types of data packets together. HK provides the capability to generate multiple combined packets so that data can be sent at different rates.
+  The HK application is used for building and sending combined telemetry messages
+  (from individual system applications) to the software bus for routing. Combining
+  messages is performed in order to minimize downlink telemetry bandwidth.
+  Combining certain data from multiple messages into one message eliminates the
+  message headers that would be required if each message was sent individually.
+  Combined messages are also useful for organizing certain types of data. This
+  application may be used for data types other than housekeeping telemetry. HK
+  provides the capability to generate multiple combined packets (a.k.a. output
+  packets) so that data can be sent at different rates (e.g. a fast, medium and
+  slow packet).
 
-## License
+  The HK application is written in C and depends on the cFS Operating System
+  Abstraction Layer (OSAL) and cFE components.  There is additional HK application
+  specific configuration information contained in the application user's guide
+  available in https://github.com/nasa/HK/tree/master/docs/users_guide
 
-This software is licensed under the NASA Open Source Agreement. http://ti.arc.nasa.gov/opensource/nosa
+  This software is licensed under the NASA Open Source Agreement.
+  http://ti.arc.nasa.gov/opensource/nosa
+
+
+Software Included
+------------------
+
+  Housekeeping application (HK) 2.4.2
+
+
+Software Required
+------------------
+
+ Operating System Abstraction Layer 5.0 or higher can be
+ obtained at https://github.com/nasa/osal
+
+ core Flight Executive 6.7.0 or higher can be obtained at
+ https://github.com/nasa/cfe
+
+ Note: An integrated bundle including the cFE, OSAL, and PSP can
+ be obtained at https://github.com/nasa/cfs
+
+About cFS
+----------
+  The cFS is a platform and project independent reusable software framework and
+  set of reusable applications developed by NASA Goddard Space Flight Center.
+  This framework is used as the basis for the flight software for satellite data
+  systems and instruments, but can be used on other embedded systems.  More
+  information on the cFS can be found at http://cfs.gsfc.nasa.gov
+
+EOF

Core Flight System (CFS) NOSA.pdf

@@ -1,35 +1,29 @@
 /************************************************************************
 ** File: hk_perfids.h
 **
-**  Copyright © 2007-2014 United States Government as represented by the 
-**  Administrator of the National Aeronautics and Space Administration. 
-**  All Other Rights Reserved.  
+** NASA Docket No. GSC-16,127-1, and identified as "Core Flight Software System
+** (CFS) Housekeeping Application Version 2” 
 **
-**  This software was created at NASA's Goddard Space Flight Center.
-**  This software is governed by the NASA Open Source Agreement and may be 
-**  used, distributed and modified only pursuant to the terms of that 
-**  agreement.
+** Copyright © 2007-2014 United States Government as represented by the
+** Administrator of the National Aeronautics and Space Administration. All Rights
+** Reserved. 
+**
+** Licensed under the Apache License, Version 2.0 (the "License"); 
+** you may not use this file except in compliance with the License. 
+** You may obtain a copy of the License at 
+** http://www.apache.org/licenses/LICENSE-2.0 
+** 
+** Unless required by applicable law or agreed to in writing, software 
+** distributed under the License is distributed on an "AS IS" BASIS, 
+** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+** See the License for the specific language governing permissions and 
+** limitations under the License. 
 **
 ** Purpose: 
 **  Define HK Performance IDs
 **
 ** Notes:
 **
-** $Log: hk_perfids.h  $
-** Revision 1.2 2015/11/10 16:49:03EST lwalling 
-** Restore data lost in MKS 2010 from MKS 2009
-** Revision 1.1 2015/07/25 21:31:04EDT rperera 
-** Initial revision
-** Member added to project /CFS-APPs-PROJECT/hk/fsw/mission_inc/project.pj
-** Revision 1.4 2015/03/04 14:58:32EST sstrege 
-** Added copyright information
-** Revision 1.3 2010/05/21 16:02:37EDT jmdagost 
-** Corrected performance ID to be the value specified in the CFS Standards doc (in decimal).
-** Revision 1.2 2010/04/09 13:20:48EDT jmdagost 
-** Changed HK performance ID from 0x00000025 to 37.  Also added doxygen comments similar to those in SC.
-** Revision 1.1 2008/05/02 12:18:41EDT rjmcgraw 
-** Initial revision
-** Member added to project c:/MKSDATA/MKS-REPOSITORY/CFS-REPOSITORY/hk/fsw/mission_inc/project.pj
 **
 *************************************************************************/
 #ifndef _hk_perfids_h_

README.md

@@ -1,38 +1,29 @@
 /************************************************************************
-** File:
-**   $Id: hk_msgids.h 1.2 2015/11/10 16:49:01EST lwalling Exp  $
+** File: hk_msgids.h 
 **
-**  Copyright © 2007-2014 United States Government as represented by the 
-**  Administrator of the National Aeronautics and Space Administration. 
-**  All Other Rights Reserved.  
+** NASA Docket No. GSC-16,127-1, and identified as "Core Flight Software System
+** (CFS) Housekeeping Application Version 2” 
 **
-**  This software was created at NASA's Goddard Space Flight Center.
-**  This software is governed by the NASA Open Source Agreement and may be 
-**  used, distributed and modified only pursuant to the terms of that 
-**  agreement.
+** Copyright © 2007-2014 United States Government as represented by the
+** Administrator of the National Aeronautics and Space Administration. All Rights
+** Reserved. 
+**
+** Licensed under the Apache License, Version 2.0 (the "License"); 
+** you may not use this file except in compliance with the License. 
+** You may obtain a copy of the License at 
+** http://www.apache.org/licenses/LICENSE-2.0 
+** 
+** Unless required by applicable law or agreed to in writing, software 
+** distributed under the License is distributed on an "AS IS" BASIS, 
+** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+** See the License for the specific language governing permissions and 
+** limitations under the License. 
 **
 ** Purpose: 
 **  The CFS Housekeeping (HK) Application Message IDs header file
 **
 ** Notes:
 **
-** $Log: hk_msgids.h  $
-** Revision 1.2 2015/11/10 16:49:01EST lwalling 
-** Restore data lost in MKS 2010 from MKS 2009
-** Revision 1.1 2015/07/25 21:31:14EDT rperera 
-** Initial revision
-** Member added to project /CFS-APPs-PROJECT/hk/fsw/platform_inc/project.pj
-** Revision 1.5 2015/03/04 14:58:29EST sstrege 
-** Added copyright information
-** Revision 1.4 2008/09/17 15:50:29EDT rjmcgraw 
-** DCR4040:1 Carriage return/line feed missing on some lines
-** Revision 1.3 2008/05/07 10:00:28EDT rjmcgraw 
-** DCR1647:4 Removed the _CMD from HK_SEND_HK_CMD_MID
-** Revision 1.2 2008/04/28 11:02:26EDT rjmcgraw 
-** DCR1647:1 Changed msg id values to CFS cpu1 assigned IDs
-** Revision 1.1 2008/04/23 11:39:38EDT rjmcgraw 
-** Initial revision
-** Member added to CFS project 
 **
 *************************************************************************/
 #ifndef _hk_msgids_h_

cfs-hk-app-OSS-readme.txt

@@ -1,44 +1,29 @@
 /************************************************************************
-** File:
-**   $Id: hk_platform_cfg.h 1.2 2015/11/10 16:49:03EST lwalling Exp  $
-**
-**  Copyright © 2007-2014 United States Government as represented by the 
-**  Administrator of the National Aeronautics and Space Administration. 
-**  All Other Rights Reserved.  
-**
-**  This software was created at NASA's Goddard Space Flight Center.
-**  This software is governed by the NASA Open Source Agreement and may be 
-**  used, distributed and modified only pursuant to the terms of that 
-**  agreement.
+** File: hk_platform_cfg.h
+**
+** NASA Docket No. GSC-16,127-1, and identified as "Core Flight Software System
+** (CFS) Housekeeping Application Version 2” 
+**
+** Copyright © 2007-2014 United States Government as represented by the
+** Administrator of the National Aeronautics and Space Administration. All Rights
+** Reserved. 
+**
+** Licensed under the Apache License, Version 2.0 (the "License"); 
+** you may not use this file except in compliance with the License. 
+** You may obtain a copy of the License at 
+** http://www.apache.org/licenses/LICENSE-2.0 
+** 
+** Unless required by applicable law or agreed to in writing, software 
+** distributed under the License is distributed on an "AS IS" BASIS, 
+** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+** See the License for the specific language governing permissions and 
+** limitations under the License. 
 **
 ** Purpose: 
 **  The CFS Housekeeping (HK) Application platform configuration header file
 **
 ** Notes:
 **
-** $Log: hk_platform_cfg.h  $
-** Revision 1.2 2015/11/10 16:49:03EST lwalling 
-** Restore data lost in MKS 2010 from MKS 2009
-** Revision 1.1 2015/07/25 21:31:16EDT rperera 
-** Initial revision
-** Member added to project /CFS-APPs-PROJECT/hk/fsw/platform_inc/project.pj
-** Revision 1.8 2015/03/04 14:58:29EST sstrege 
-** Added copyright information
-** Revision 1.7 2012/08/15 18:32:39EDT aschoeni 
-** Added ability to discard incomplete combo packets
-** Revision 1.6 2011/06/23 12:00:02EDT jmdagost 
-** Moved HK_MISSION_REV from version header to here.
-** Revision 1.5 2010/05/06 15:32:55EDT jmdagost 
-** Changed location of hk_cpy_tbl.tbl from /cf/ to /cf/apps/
-** Revision 1.4 2009/12/03 16:32:17EST jmdagost 
-** Expanded comment on mempool size definition, corrected copy table filename.
-** Revision 1.3 2009/04/18 12:55:14EDT dkobe 
-** Updates to correct doxygen comments
-** Revision 1.2 2008/05/07 09:55:22EDT rjmcgraw 
-** DCR1647:3 Romoved the Hk from copy table name and runtime table name
-** Revision 1.1 2008/04/09 16:39:33EDT rjmcgraw 
-** Initial revision
-** Member added to project c:/MKSDATA/MKS-REPOSITORY/CFS-REPOSITORY/hk/fsw/platform_inc/project.pj
 **
 *************************************************************************/
 #ifndef _hk_platform_cfg_h_
@@ -141,7 +126,7 @@
 **       the #OS_MAX_PATH_LEN value.
 */
 
-#define HK_COPY_TABLE_FILENAME  "/cf/apps/hk_cpy_tbl.tbl"
+#define HK_COPY_TABLE_FILENAME  "/cf/hk_cpy_tbl.tbl"
 
 /** \hkcfg Mission specific version number for HK application
 **