abp_eco.h

00001 /*******************************************************************************
00002 ********************************************************************************
00003 **                                                                            **
00004 ** ABP version 7.16.01 (2015-10-14)                                           **
00005 **                                                                            */
00006 /*******************************************************************************
00007 ********************************************************************************
00008 **
00009 ** File Name
00010 ** ---------
00011 **
00012 ** abp_eco.h
00013 **
00014 ********************************************************************************
00015 ********************************************************************************
00016 **
00017 ** Description
00018 ** -----------
00019 **
00020 ** abp_eco.h - Anybus-CC Energy Control Object Protocol Definitions.
00021 **
00022 ** This software component contains Energy Control definitions used by Anybus-CC
00023 ** modules as well as applications designed to use such modules.
00024 **
00025 ********************************************************************************
00026 ********************************************************************************
00027 **                                                                            **
00028 ** COPYRIGHT NOTIFICATION (c) 2011 HMS Industrial Networks AB                 **
00029 **                                                                            **
00030 ** This code is the property of HMS Industrial Networks AB.                   **
00031 ** The source code may not be reproduced, distributed, or used without        **
00032 ** permission. When used together with a product from HMS, this code can be   **
00033 ** modified, reproduced and distributed in binary form without any            **
00034 ** restrictions.                                                              **
00035 **                                                                            **
00036 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT    **
00037 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR     **
00038 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR     **
00039 ** THAT DEFECTS IN IT CAN BE CORRECTED.                                       **
00040 **                                                                            **
00041 ********************************************************************************
00042 ********************************************************************************
00043 */
00044 
00045 #ifndef ABP_ECO_H
00046 #define ABP_ECO_H
00047 
00048 
00049 /*******************************************************************************
00050 **
00051 ** Anybus-CC Energy Control Object constants.
00052 **
00053 ** Object revision: 2.
00054 **
00055 ********************************************************************************
00056 */
00057 
00058 /*------------------------------------------------------------------------------
00059 **
00060 ** The Anybus-CC Energy Control object specific attributes.
00061 **
00062 **------------------------------------------------------------------------------
00063 */
00064 
00065 #define ABP_ECO_OA_CURRENT_ENERGY_SAVING_MODE   11
00066 #define ABP_ECO_OA_REMAINING_TIME_TO_DEST       12
00067 #define ABP_ECO_OA_ENERGY_CONSUMP_TO_DEST       13
00068 
00069 
00070 /*------------------------------------------------------------------------------
00071 **
00072 ** The data size of the Anybus-CC Energy Control object specific
00073 ** attributes (in bytes).
00074 **
00075 **------------------------------------------------------------------------------
00076 */
00077 
00078 #define ABP_ECO_OA_CURRENT_ENERGY_SAVING_MODE_DS   ABP_UINT16_SIZEOF
00079 #define ABP_ECO_OA_REMAINING_TIME_TO_DEST_DS       ABP_UINT32_SIZEOF
00080 #define ABP_ECO_OA_ENERGY_CONSUMP_TO_DEST_DS       ABP_FLOAT_SIZEOF
00081 
00082 
00083 /*------------------------------------------------------------------------------
00084 **
00085 ** The Anybus-CC Energy Control object instance attributes.
00086 **
00087 **------------------------------------------------------------------------------
00088 */
00089 
00090 #define ABP_ECO_IA_MODE_ATTRIBUTES           1
00091 #define ABP_ECO_IA_TIME_MIN_PAUSE            2
00092 #define ABP_ECO_IA_TIME_TO_PAUSE             3
00093 #define ABP_ECO_IA_TIME_TO_OPERATE           4
00094 #define ABP_ECO_IA_TIME_MIN_LENGTH_OF_STAY   5
00095 #define ABP_ECO_IA_TIME_MAX_LENGTH_OF_STAY   6
00096 #define ABP_ECO_IA_MODE_POWER_CONSUMP        7
00097 #define ABP_ECO_IA_ENERGY_CONSUMP_TO_PAUSE   8
00098 #define ABP_ECO_IA_ENERGY_CONSUMP_TO_OPERATE 9
00099 #define ABP_ECO_IA_AVAILABILITY              10
00100 #define ABP_ECO_IA_POWER_CONSUMPTION         11
00101 
00102 
00103 /*------------------------------------------------------------------------------
00104 **
00105 ** The data size of the Anybus-CC Energy Control object instance attributes
00106 ** (in bytes).
00107 **
00108 **------------------------------------------------------------------------------
00109 */
00110 
00111 #define ABP_ECO_IA_MODE_ATTRIBUTES_DS              ABP_UINT16_SIZEOF
00112 #define ABP_ECO_IA_TIME_MIN_PAUSE_DS               ABP_UINT32_SIZEOF
00113 #define ABP_ECO_IA_TIME_TO_PAUSE_DS                ABP_UINT32_SIZEOF
00114 #define ABP_ECO_IA_TIME_TO_OPERATE_DS              ABP_UINT32_SIZEOF
00115 #define ABP_ECO_IA_TIME_MIN_LENGTH_OF_STAY_DS      ABP_UINT32_SIZEOF
00116 #define ABP_ECO_IA_TIME_MAX_LENGTH_OF_STAY_DS      ABP_UINT32_SIZEOF
00117 #define ABP_ECO_IA_MODE_POWER_CONSUMP_DS           ABP_FLOAT_SIZEOF
00118 #define ABP_ECO_IA_ENERGY_CONSUMP_TO_PAUSE_DS      ABP_FLOAT_SIZEOF
00119 #define ABP_ECO_IA_ENERGY_CONSUMP_TO_OPERATE_DS    ABP_FLOAT_SIZEOF
00120 #define ABP_ECO_IA_AVAILABILITY_DS                 ABP_BOOL_SIZEOF
00121 #define ABP_ECO_IA_POWER_CONSUMPTION_DS            ABP_UINT32_SIZEOF
00122 
00123 
00124 /*------------------------------------------------------------------------------
00125 **
00126 ** The Anybus-CC Energy Control object specific message commands.
00127 **
00128 **------------------------------------------------------------------------------
00129 */
00130 
00131 #define ABP_ECO_CMD_START_PAUSE           0x10
00132 #define ABP_ECO_CMD_END_PAUSE             0x11
00133 #define ABP_ECO_CMD_PREVIEW_PAUSE_TIME    0x12
00134 
00135 
00136 #endif  /* inclusion lock */
00137 
00138 /*******************************************************************************
00139 **
00140 ** End of abp_eco.h
00141 **
00142 ********************************************************************************
00143 */