Erick / Mbed 2 deprecated ICE_BLE_TEST

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   NaturalTinyShell_ice libmDot-12Sept mbed-rtos mbed

Fork of ICE by Erick

src/ConfigurationHandler/Controls/SetpointControl.cpp@93:1553fb156915, 2016-09-20 (annotated)

Committer:
jmarkel44
Date:
Tue Sep 20 19:31:38 2016 +0000
Revision:
93:1553fb156915
Parent:
92:9a6a1adca19c
Child:
94:18ae2fd82638
setpoint control cleanup;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jmarkel44 14:cc916fa8dd11 1 /******************************************************************************
jmarkel44 14:cc916fa8dd11 2 *
jmarkel44 19:9bc8fabeddfa 3 * File: SetpointControl.cpp
jmarkel44 20:653923c2f37a 4 * Desciption: ICE Setpoint Control Class implementation
jmarkel44 14:cc916fa8dd11 5 *
jmarkel44 14:cc916fa8dd11 6 *****************************************************************************/
jmarkel44 13:c80c283f9db2 7 #include "SetpointControl.h"
jmarkel44 14:cc916fa8dd11 8 #include "mDot.h"
jmarkel44 20:653923c2f37a 9 #include "MbedJSONValue.h"
davidjhoward 91:0e8d76030598 10 #include "ModbusMasterApi.h"
jmarkel44 51:66b820f203a5 11 #include "global.h"
jmarkel44 28:c410a61238bb 12 #include <string>
jmarkel44 13:c80c283f9db2 13
jmarkel44 14:cc916fa8dd11 14 extern mDot *GLOBAL_mdot;
jmarkel44 14:cc916fa8dd11 15
jmarkel44 56:225786c56315 16 // Method: load
jmarkel44 56:225786c56315 17 // Description: open the configuration file and assign data to the
jmarkel44 56:225786c56315 18 // setpoint control object
jmarkel44 56:225786c56315 19 //
jmarkel44 56:225786c56315 20 // @param controlFile -> name of the control file
jmarkel44 56:225786c56315 21 // @return true if data is assigned; false on error
jmarkel44 56:225786c56315 22
jmarkel44 28:c410a61238bb 23 bool SetpointControl::load(string _controlFile)
jmarkel44 20:653923c2f37a 24 {
jmarkel44 51:66b820f203a5 25 MbedJSONValue json_value; // JSON parsing element
jmarkel44 51:66b820f203a5 26 controlFile = _controlFile;
jmarkel44 51:66b820f203a5 27
jmarkel44 56:225786c56315 28 // open and read from the control file
jmarkel44 14:cc916fa8dd11 29 mDot::mdot_file file = GLOBAL_mdot->openUserFile(controlFile.c_str(), mDot::FM_RDONLY);
jmarkel44 51:66b820f203a5 30 if ( file.fd < 0 )
jmarkel44 28:c410a61238bb 31 return false;
jmarkel44 20:653923c2f37a 32
jmarkel44 20:653923c2f37a 33 // read the data into a buffer
jmarkel44 28:c410a61238bb 34 char dataBuf[1024];
jmarkel44 28:c410a61238bb 35
jmarkel44 28:c410a61238bb 36 int bytes_read = GLOBAL_mdot->readUserFile(file, (void *)dataBuf, sizeof(dataBuf));
jmarkel44 28:c410a61238bb 37 if ( bytes_read != sizeof(dataBuf) ) {
jmarkel44 28:c410a61238bb 38 logError("%s: failed to read %d bytes from %s", __func__, sizeof(dataBuf), controlFile.c_str());
jmarkel44 93:1553fb156915 39 // caller should destroy the object
jmarkel44 28:c410a61238bb 40 return false;
jmarkel44 28:c410a61238bb 41 }
jmarkel44 51:66b820f203a5 42
jmarkel44 51:66b820f203a5 43 // close the file
jmarkel44 28:c410a61238bb 44 GLOBAL_mdot->closeUserFile(file);
jmarkel44 28:c410a61238bb 45
jmarkel44 51:66b820f203a5 46 // parse the json data
jmarkel44 28:c410a61238bb 47 parse(json_value, dataBuf);
jmarkel44 51:66b820f203a5 48
jmarkel44 28:c410a61238bb 49 id = json_value["id"].get<string>();
jmarkel44 28:c410a61238bb 50 priority = atoi(json_value["priority"].get<string>().c_str());
jmarkel44 28:c410a61238bb 51 input = json_value["input"].get<string>();
jmarkel44 28:c410a61238bb 52 output = json_value["output"].get<string>();
jmarkel44 89:55ac65d7f206 53 setpoint = atof(json_value["setpoint"].get<string>().c_str());
jmarkel44 28:c410a61238bb 54 productFactor = atof(json_value["prodfact"].get<string>().c_str());
jmarkel44 90:7d9731dec0da 55 actingDir = atoi(json_value["actingDir"].get<string>().c_str());
jmarkel44 28:c410a61238bb 56 highAlert = atof(json_value["halert"].get<string>().c_str());
jmarkel44 28:c410a61238bb 57 lowAlert = atof(json_value["lalert"].get<string>().c_str());
jmarkel44 28:c410a61238bb 58 highFailsafe = atof(json_value["hfs"].get<string>().c_str());
jmarkel44 28:c410a61238bb 59 lowFailsafe = atof(json_value["lfs"].get<string>().c_str());
jmarkel44 20:653923c2f37a 60
jmarkel44 56:225786c56315 61 return true; // object created successfully
jmarkel44 51:66b820f203a5 62 }
jmarkel44 51:66b820f203a5 63
jmarkel44 56:225786c56315 64 // Method: start
jmarkel44 56:225786c56315 65 // Description: start the setpoint control
jmarkel44 56:225786c56315 66 //
jmarkel44 56:225786c56315 67 // @param none
jmarkel44 56:225786c56315 68 // @return none
jmarkel44 56:225786c56315 69
jmarkel44 51:66b820f203a5 70 void SetpointControl::start(void)
jmarkel44 51:66b820f203a5 71 {
jmarkel44 56:225786c56315 72 // this is the initial state; what else needs to be done??
jmarkel44 51:66b820f203a5 73 this->currentState = STATE_STARTUP;
jmarkel44 19:9bc8fabeddfa 74 }
jmarkel44 19:9bc8fabeddfa 75
jmarkel44 56:225786c56315 76 // Method: update
jmarkel44 56:225786c56315 77 // Description: based on the state of the control, check for
jmarkel44 56:225786c56315 78 // under limit and over limit values, adjust the
jmarkel44 56:225786c56315 79 // state accordingly
jmarkel44 56:225786c56315 80 //
jmarkel44 56:225786c56315 81 // @param none
jmarkel44 56:225786c56315 82 // @return none
jmarkel44 56:225786c56315 83
jmarkel44 51:66b820f203a5 84 void SetpointControl::update(void)
jmarkel44 51:66b820f203a5 85 {
jmarkel44 51:66b820f203a5 86 switch (this->currentState) {
jmarkel44 51:66b820f203a5 87 case STATE_STARTUP:
jmarkel44 51:66b820f203a5 88 if ( this->underLimit() ) {
jmarkel44 51:66b820f203a5 89 // start the feed right away
jmarkel44 51:66b820f203a5 90 this->startFeed();
jmarkel44 51:66b820f203a5 91 this->currentState = STATE_CONTROL_ON;
jmarkel44 51:66b820f203a5 92 } else {
jmarkel44 51:66b820f203a5 93 this->currentState = STATE_CONTROL_OFF;
jmarkel44 51:66b820f203a5 94 }
jmarkel44 51:66b820f203a5 95 break;
jmarkel44 51:66b820f203a5 96 case STATE_CONTROL_ON:
jmarkel44 51:66b820f203a5 97 if ( this->overLimit() ) {
jmarkel44 51:66b820f203a5 98 // stop the feed
jmarkel44 51:66b820f203a5 99 this->stopFeed();
jmarkel44 51:66b820f203a5 100 this->currentState = STATE_CONTROL_OFF;
jmarkel44 51:66b820f203a5 101 } else {
jmarkel44 51:66b820f203a5 102 // do nothing
jmarkel44 51:66b820f203a5 103 }
jmarkel44 51:66b820f203a5 104 break;
jmarkel44 51:66b820f203a5 105 case STATE_CONTROL_OFF:
jmarkel44 51:66b820f203a5 106 if ( this->underLimit() ) {
jmarkel44 51:66b820f203a5 107 // start the feed
jmarkel44 51:66b820f203a5 108 this->startFeed();
jmarkel44 51:66b820f203a5 109 this->currentState = STATE_CONTROL_ON;
jmarkel44 51:66b820f203a5 110 } else {
jmarkel44 51:66b820f203a5 111 // do nothing
jmarkel44 51:66b820f203a5 112 }
jmarkel44 51:66b820f203a5 113 break;
jmarkel44 56:225786c56315 114 //case STATE_CONTROL_DISABLED:
jmarkel44 56:225786c56315 115 //case STATE_CONTROL_PAUSED:
jmarkel44 51:66b820f203a5 116 default:
jmarkel44 51:66b820f203a5 117 break;
jmarkel44 51:66b820f203a5 118 }
jmarkel44 51:66b820f203a5 119 }
jmarkel44 51:66b820f203a5 120
jmarkel44 56:225786c56315 121 // Method: overLimit
jmarkel44 56:225786c56315 122 // Description: (see @return)
jmarkel44 56:225786c56315 123 //
jmarkel44 56:225786c56315 124 // @param none
jmarkel44 56:225786c56315 125 // @return true if product is over the upper limit for normal mode
jmarkel44 56:225786c56315 126 // or under the limit for reverse mode; false otherwise
jmarkel44 56:225786c56315 127
jmarkel44 51:66b820f203a5 128 bool SetpointControl::overLimit(void)
jmarkel44 51:66b820f203a5 129 {
davidjhoward 91:0e8d76030598 130 ModbusValue value;
jmarkel44 92:9a6a1adca19c 131 ModbusMasterReadRegister( input, &value );
jmarkel44 92:9a6a1adca19c 132 float flimit;
davidjhoward 91:0e8d76030598 133
jmarkel44 92:9a6a1adca19c 134 if ( !actingDir ) {
jmarkel44 92:9a6a1adca19c 135 flimit = setpoint + (setpoint * .04);
jmarkel44 92:9a6a1adca19c 136 return (value.value > flimit);
jmarkel44 92:9a6a1adca19c 137 } else {
jmarkel44 92:9a6a1adca19c 138 flimit = setpoint - (setpoint * .04);
jmarkel44 92:9a6a1adca19c 139 return (value.value < flimit);
davidjhoward 91:0e8d76030598 140 }
jmarkel44 51:66b820f203a5 141 }
jmarkel44 51:66b820f203a5 142
jmarkel44 92:9a6a1adca19c 143
jmarkel44 56:225786c56315 144 // Method: underLimit
jmarkel44 56:225786c56315 145 // Description: (see @return)
jmarkel44 56:225786c56315 146 //
jmarkel44 56:225786c56315 147 // @param none
jmarkel44 56:225786c56315 148 // @return true if product is under lower limit for normal mode or
jmarkel44 56:225786c56315 149 // over the upper limit for reverse mode; false otherwise
jmarkel44 56:225786c56315 150
jmarkel44 51:66b820f203a5 151 bool SetpointControl::underLimit(void)
jmarkel44 51:66b820f203a5 152 {
davidjhoward 91:0e8d76030598 153 ModbusValue value;
jmarkel44 92:9a6a1adca19c 154 ModbusMasterReadRegister( input, &value );
jmarkel44 92:9a6a1adca19c 155 float flimit;
davidjhoward 91:0e8d76030598 156
jmarkel44 92:9a6a1adca19c 157 if ( !actingDir ) {
jmarkel44 92:9a6a1adca19c 158 flimit = setpoint - (setpoint * .04);
jmarkel44 92:9a6a1adca19c 159 return (value.value < flimit);
jmarkel44 92:9a6a1adca19c 160 } else {
jmarkel44 92:9a6a1adca19c 161 flimit = setpoint + (setpoint * .04);
jmarkel44 92:9a6a1adca19c 162 return (value.value > flimit);
davidjhoward 91:0e8d76030598 163 }
jmarkel44 51:66b820f203a5 164 }
jmarkel44 51:66b820f203a5 165
jmarkel44 56:225786c56315 166 // Method: startFeed()
jmarkel44 56:225786c56315 167 // Description: send ON indication to Output Master for this control's
jmarkel44 56:225786c56315 168 // relay
jmarkel44 56:225786c56315 169 //
jmarkel44 56:225786c56315 170 // @param none
jmarkel44 56:225786c56315 171 // @return none
jmarkel44 56:225786c56315 172
jmarkel44 51:66b820f203a5 173 void SetpointControl::startFeed(void)
jmarkel44 51:66b820f203a5 174 {
jmarkel44 56:225786c56315 175 logInfo("%s: %s attempting to start feed on relay %s\n",
jmarkel44 56:225786c56315 176 __func__, controlFile.c_str(), output.c_str());
jmarkel44 56:225786c56315 177
jmarkel44 71:34856d21f2bf 178 OutputControlMsg_t *output_mail = OutputMasterMailBox.alloc();
jmarkel44 71:34856d21f2bf 179 memset(output_mail, 0, sizeof(OutputControlMsg_t));
jmarkel44 71:34856d21f2bf 180 output_mail->action = ACTION_CONTROL_ON;
jmarkel44 71:34856d21f2bf 181 output_mail->priority = this->priority;
jmarkel44 71:34856d21f2bf 182 strncpy(output_mail->output, this->output.c_str(), sizeof(output_mail->output)-1);
jmarkel44 71:34856d21f2bf 183 strncpy(output_mail->id, this->id.c_str(), sizeof(output_mail->id)-1);
jmarkel44 71:34856d21f2bf 184 OutputMasterMailBox.put(output_mail);
jmarkel44 51:66b820f203a5 185 }
jmarkel44 51:66b820f203a5 186
jmarkel44 56:225786c56315 187 // Method: stopFeed
jmarkel44 56:225786c56315 188 // Description: send OFF indication to Output Master for this control's
jmarkel44 56:225786c56315 189 // relay
jmarkel44 56:225786c56315 190 //
jmarkel44 56:225786c56315 191 // @param none
jmarkel44 56:225786c56315 192 // @return none
jmarkel44 56:225786c56315 193
jmarkel44 51:66b820f203a5 194 void SetpointControl::stopFeed(void)
jmarkel44 51:66b820f203a5 195 {
jmarkel44 71:34856d21f2bf 196 logInfo("%s: %s attempting to stop feed on relay %s\n",
jmarkel44 56:225786c56315 197 __func__, controlFile.c_str(), output.c_str());
jmarkel44 56:225786c56315 198
jmarkel44 71:34856d21f2bf 199 OutputControlMsg_t *output_mail = OutputMasterMailBox.alloc();
jmarkel44 71:34856d21f2bf 200 memset(output_mail, 0, sizeof(OutputControlMsg_t));
jmarkel44 71:34856d21f2bf 201 output_mail->action = ACTION_CONTROL_OFF;
jmarkel44 71:34856d21f2bf 202 output_mail->priority = this->priority;
jmarkel44 71:34856d21f2bf 203 strncpy(output_mail->output, this->output.c_str(), sizeof(output_mail->output)-1);
jmarkel44 71:34856d21f2bf 204 strncpy(output_mail->id, this->id.c_str(), sizeof(output_mail->id)-1);
jmarkel44 71:34856d21f2bf 205 OutputMasterMailBox.put(output_mail);
jmarkel44 72:3754b352f156 206 }
jmarkel44 72:3754b352f156 207
jmarkel44 72:3754b352f156 208 // Method: unregisterControl
jmarkel44 72:3754b352f156 209 // Description: send OFF indication to Output Master for this control's
jmarkel44 72:3754b352f156 210 // relay
jmarkel44 72:3754b352f156 211 //
jmarkel44 72:3754b352f156 212 // @param none
jmarkel44 72:3754b352f156 213 // @return none
jmarkel44 72:3754b352f156 214 void SetpointControl::unregisterControl(void)
jmarkel44 72:3754b352f156 215 {
jmarkel44 72:3754b352f156 216 logInfo("%s: %s attempting to stop feed on relay %s\n",
jmarkel44 72:3754b352f156 217 __func__, controlFile.c_str(), output.c_str());
jmarkel44 72:3754b352f156 218
jmarkel44 72:3754b352f156 219 OutputControlMsg_t *output_mail = OutputMasterMailBox.alloc();
jmarkel44 72:3754b352f156 220 memset(output_mail, 0, sizeof(OutputControlMsg_t));
jmarkel44 72:3754b352f156 221 output_mail->action = ACTION_CONTROL_UNREGISTER;
jmarkel44 72:3754b352f156 222 output_mail->priority = this->priority;
jmarkel44 72:3754b352f156 223 strncpy(output_mail->output, this->output.c_str(), sizeof(output_mail->output)-1);
jmarkel44 72:3754b352f156 224 strncpy(output_mail->id, this->id.c_str(), sizeof(output_mail->id)-1);
jmarkel44 72:3754b352f156 225 OutputMasterMailBox.put(output_mail);
jmarkel44 93:1553fb156915 226 }
jmarkel44 93:1553fb156915 227
jmarkel44 93:1553fb156915 228 void SetpointControl::display(void)
jmarkel44 93:1553fb156915 229 {
jmarkel44 93:1553fb156915 230 string mapper[] = { "STARTUP",
jmarkel44 93:1553fb156915 231 "CONTROL_OFF",
jmarkel44 93:1553fb156915 232 "CONTROL_ON",
jmarkel44 93:1553fb156915 233 "CONTROL_DISABLE",
jmarkel44 93:1553fb156915 234 "CONTROL_PAUSE",
jmarkel44 93:1553fb156915 235 "CONTROL_MAX" };
jmarkel44 93:1553fb156915 236
jmarkel44 93:1553fb156915 237
jmarkel44 93:1553fb156915 238 printf("\r controlFile : %s \n", controlFile.c_str());
jmarkel44 93:1553fb156915 239 printf("\r id : %s \n", id.c_str());
jmarkel44 93:1553fb156915 240 printf("\r priority : %d \n", priority);
jmarkel44 93:1553fb156915 241 printf("\r input : %s \n", input.c_str());
jmarkel44 93:1553fb156915 242 printf("\r output : %s \n", output.c_str());
jmarkel44 93:1553fb156915 243 printf("\r setpoint : %0.2f\n", setpoint);
jmarkel44 93:1553fb156915 244 printf("\r prodfact : %0.2f\n", productFactor);
jmarkel44 93:1553fb156915 245 printf("\r actingDir : %d \n", actingDir);
jmarkel44 93:1553fb156915 246 printf("\r halert : %0.2f\n", highAlert);
jmarkel44 93:1553fb156915 247 printf("\r lalert : %0.2f\n", lowAlert);
jmarkel44 93:1553fb156915 248 printf("\r hfs : %0.2f\n", highFailsafe);
jmarkel44 93:1553fb156915 249 printf("\r lfs : %0.2f\n", lowFailsafe);
jmarkel44 93:1553fb156915 250 printf("\r\n");
jmarkel44 93:1553fb156915 251 printf("\r currentState: %s\n", mapper[currentState].c_str());
jmarkel44 93:1553fb156915 252 printf("\r\n");
jmarkel44 51:66b820f203a5 253 }