Damien Frost / SolarNanoGrid_Field

The field version of the solarnano grid on the ionQubes

Fork of SolarNanoGridv3 by SONG Project

Battery/Battery.h@11:87ab310924f0, 2016-06-08 (annotated)

Committer:
epgmdm
Date:
Wed Jun 08 22:12:52 2016 +0000
Revision:
11:87ab310924f0
Parent:
10:30c9e8df0032
Child:
12:d9b13f31206d
Utility up

Who changed what in which revision?

UserRevisionLine numberNew contents of line
defrost 5:57b06b4b47c6 1 /**
defrost 5:57b06b4b47c6 2 *@section DESCRIPTION
defrost 5:57b06b4b47c6 3 * mbed SolarNanogrid Battery.
defrost 5:57b06b4b47c6 4 *@section LICENSE
defrost 5:57b06b4b47c6 5 * Copyright (c) 2016, Malcolm McCulloch
defrost 5:57b06b4b47c6 6 *
defrost 5:57b06b4b47c6 7 * Permission is hereby granted, free of charge, to any person obtaining a copy
defrost 5:57b06b4b47c6 8 * of this software and associated documentation files (the "Software"), to deal
defrost 5:57b06b4b47c6 9 * in the Software without restriction, including without limitation the rights
defrost 5:57b06b4b47c6 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
defrost 5:57b06b4b47c6 11 * copies of the Software, and to permit persons to whom the Software is
defrost 5:57b06b4b47c6 12 * furnished to do so, subject to the following conditions:
defrost 5:57b06b4b47c6 13 *
defrost 5:57b06b4b47c6 14 * The above copyright notice and this permission notice shall be included in
defrost 5:57b06b4b47c6 15 * all copies or substantial portions of the Software.
defrost 5:57b06b4b47c6 16 *
defrost 5:57b06b4b47c6 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
defrost 5:57b06b4b47c6 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
defrost 5:57b06b4b47c6 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
defrost 5:57b06b4b47c6 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
defrost 5:57b06b4b47c6 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
defrost 5:57b06b4b47c6 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
defrost 5:57b06b4b47c6 23 * THE SOFTWARE.
defrost 5:57b06b4b47c6 24 * @file "Battery.h"
defrost 5:57b06b4b47c6 25 */
defrost 5:57b06b4b47c6 26
defrost 5:57b06b4b47c6 27 #ifndef BATTERY_H
defrost 5:57b06b4b47c6 28 #define BATTERY_H
defrost 5:57b06b4b47c6 29 #include <mbed.h>
defrost 5:57b06b4b47c6 30 #include "NRF2401P.h"
defrost 5:57b06b4b47c6 31 #include "nRF24l01.h"
defrost 5:57b06b4b47c6 32 #include "SDFileSystem.h"
defrost 5:57b06b4b47c6 33 #include "SolarNanoGrid.h"
defrost 10:30c9e8df0032 34
defrost 5:57b06b4b47c6 35 /** \brief The battery logs data and interacts with the locker.
defrost 5:57b06b4b47c6 36 *
defrost 5:57b06b4b47c6 37 * The config.ini must start with B
defrost 5:57b06b4b47c6 38 *
defrost 5:57b06b4b47c6 39 */
defrost 5:57b06b4b47c6 40 class Battery : public SolarNanoGrid
defrost 5:57b06b4b47c6 41 {
defrost 5:57b06b4b47c6 42 public:
defrost 5:57b06b4b47c6 43 // *********************
defrost 5:57b06b4b47c6 44 // * Public variables: *
defrost 5:57b06b4b47c6 45 // *********************
adrienBiz 8:0acda4f2e0a8 46 char* logDir;
adrienBiz 8:0acda4f2e0a8 47 float maxChargeRate; // Charge rate in amps
defrost 5:57b06b4b47c6 48
defrost 5:57b06b4b47c6 49 // *********************
defrost 5:57b06b4b47c6 50 // * Public functions: *
defrost 5:57b06b4b47c6 51 // *********************
defrost 5:57b06b4b47c6 52
defrost 5:57b06b4b47c6 53 // Constructor:
epgmdm 11:87ab310924f0 54 Battery(FILE* fp, Serial *pc);
defrost 5:57b06b4b47c6 55
defrost 5:57b06b4b47c6 56 // Main loop function:
defrost 5:57b06b4b47c6 57 void loop(void);
defrost 5:57b06b4b47c6 58 /**
defrost 5:57b06b4b47c6 59 * Checks in the battery to the locker
defrost 5:57b06b4b47c6 60 * Transmits "C ID"
defrost 5:57b06b4b47c6 61 */
defrost 5:57b06b4b47c6 62 void checkIn();
defrost 5:57b06b4b47c6 63
defrost 5:57b06b4b47c6 64
defrost 5:57b06b4b47c6 65 protected:
defrost 5:57b06b4b47c6 66 // **********************
defrost 5:57b06b4b47c6 67 // * Protected variables: *
defrost 5:57b06b4b47c6 68 // **********************
defrost 5:57b06b4b47c6 69 /**
defrost 5:57b06b4b47c6 70 * Name of log directory, include last /
defrost 5:57b06b4b47c6 71 */
defrost 5:57b06b4b47c6 72
adrienBiz 8:0acda4f2e0a8 73 char count;
adrienBiz 8:0acda4f2e0a8 74 char* txFileName;
defrost 5:57b06b4b47c6 75
adrienBiz 8:0acda4f2e0a8 76 char* fullTxFilePath;
defrost 5:57b06b4b47c6 77
adrienBiz 8:0acda4f2e0a8 78 int sizeRead;
adrienBiz 8:0acda4f2e0a8 79 unsigned int fileLength;
adrienBiz 8:0acda4f2e0a8 80 unsigned int filePointer;
adrienBiz 8:0acda4f2e0a8 81 unsigned int fileLeft;
adrienBiz 8:0acda4f2e0a8 82 char *sdBuffer;
adrienBiz 8:0acda4f2e0a8 83 unsigned int sdBuffPnt;
defrost 5:57b06b4b47c6 84 /**
defrost 5:57b06b4b47c6 85 * Open channel address of the locker
defrost 5:57b06b4b47c6 86 */
adrienBiz 8:0acda4f2e0a8 87 long long openAddr;
defrost 5:57b06b4b47c6 88
defrost 5:57b06b4b47c6 89 /**
defrost 5:57b06b4b47c6 90 * Private channel address of the locker
defrost 5:57b06b4b47c6 91 */
adrienBiz 8:0acda4f2e0a8 92 long long privateAddr;
defrost 5:57b06b4b47c6 93
adrienBiz 8:0acda4f2e0a8 94 unsigned int countSD;
defrost 5:57b06b4b47c6 95
defrost 5:57b06b4b47c6 96 // **********************
defrost 5:57b06b4b47c6 97 // * Protected flags: *
defrost 5:57b06b4b47c6 98 // **********************
adrienBiz 8:0acda4f2e0a8 99 volatile char * flag;
adrienBiz 8:0acda4f2e0a8 100 volatile char checkedIn;
adrienBiz 8:0acda4f2e0a8 101 volatile char flagGetTime;
adrienBiz 8:0acda4f2e0a8 102 volatile char flagNextFile;
adrienBiz 8:0acda4f2e0a8 103 volatile char flagSendFileName;
adrienBiz 8:0acda4f2e0a8 104 volatile char flagSendFileSize;
adrienBiz 8:0acda4f2e0a8 105 volatile char flagSendFile;
adrienBiz 8:0acda4f2e0a8 106 volatile char flagSendFileDone;
defrost 5:57b06b4b47c6 107
defrost 5:57b06b4b47c6 108
defrost 5:57b06b4b47c6 109 // **********************
defrost 5:57b06b4b47c6 110 // * Protected interrupts: *
defrost 5:57b06b4b47c6 111 // **********************
adrienBiz 8:0acda4f2e0a8 112 InterruptIn* button;
adrienBiz 8:0acda4f2e0a8 113 Ticker* txWatch;
adrienBiz 8:0acda4f2e0a8 114 Timeout* delay;
defrost 5:57b06b4b47c6 115
defrost 5:57b06b4b47c6 116 // **********************
defrost 5:57b06b4b47c6 117 // * Protected functions: *
defrost 5:57b06b4b47c6 118 // **********************
defrost 5:57b06b4b47c6 119 /**
defrost 5:57b06b4b47c6 120 * Checks in the battery to the locker
defrost 5:57b06b4b47c6 121 * Acknowledge received.
defrost 5:57b06b4b47c6 122 * Changes the TX pipe address to private
defrost 5:57b06b4b47c6 123 *
defrost 5:57b06b4b47c6 124 */
defrost 5:57b06b4b47c6 125 void doCheckIn();
defrost 5:57b06b4b47c6 126 /**
defrost 5:57b06b4b47c6 127 * Checks out the battery from the locker
defrost 5:57b06b4b47c6 128 * Acknowledge received.
defrost 5:57b06b4b47c6 129 * Changes the TX pipe address to open
defrost 5:57b06b4b47c6 130 *
defrost 5:57b06b4b47c6 131 */
defrost 5:57b06b4b47c6 132 void doCheckOut();
defrost 5:57b06b4b47c6 133 /**
defrost 5:57b06b4b47c6 134 * sends a request for time update.
defrost 5:57b06b4b47c6 135 */
defrost 5:57b06b4b47c6 136 void getTime();
defrost 5:57b06b4b47c6 137 /**
defrost 5:57b06b4b47c6 138 * Sets the value pointed to by flag to 1.
defrost 5:57b06b4b47c6 139 */
defrost 5:57b06b4b47c6 140
defrost 5:57b06b4b47c6 141 void nextFileToTx();
defrost 5:57b06b4b47c6 142 void sendDirName();
defrost 5:57b06b4b47c6 143 void sendFileName();
defrost 5:57b06b4b47c6 144 void sendFileSize();
defrost 5:57b06b4b47c6 145 void sendFile();
defrost 5:57b06b4b47c6 146 void sendFileDone();
defrost 5:57b06b4b47c6 147 void setFlag();
defrost 5:57b06b4b47c6 148 /**
defrost 5:57b06b4b47c6 149 * Retransmits the last data.
defrost 5:57b06b4b47c6 150 *
defrost 5:57b06b4b47c6 151 */
defrost 5:57b06b4b47c6 152 void retransmit();
defrost 5:57b06b4b47c6 153
defrost 5:57b06b4b47c6 154
defrost 5:57b06b4b47c6 155 /**
defrost 5:57b06b4b47c6 156 * called when the nrf the button is pressed
defrost 5:57b06b4b47c6 157 *
defrost 5:57b06b4b47c6 158 */
defrost 5:57b06b4b47c6 159 void intButton();
defrost 5:57b06b4b47c6 160 /**
defrost 5:57b06b4b47c6 161 * called when the nrf creates an interrupt.
defrost 5:57b06b4b47c6 162 *
defrost 5:57b06b4b47c6 163 */
defrost 5:57b06b4b47c6 164 void intNrf();
defrost 5:57b06b4b47c6 165
defrost 5:57b06b4b47c6 166 private:
defrost 5:57b06b4b47c6 167 // **********************
defrost 5:57b06b4b47c6 168 // * Private variables: *
defrost 5:57b06b4b47c6 169 // **********************
defrost 5:57b06b4b47c6 170
adrienBiz 8:0acda4f2e0a8 171 volatile bool maxRT;
defrost 5:57b06b4b47c6 172
defrost 5:57b06b4b47c6 173 };
defrost 5:57b06b4b47c6 174 #endif