The field version of the solarnano grid on the ionQubes
Fork of SolarNanoGridv3 by
Battery/Battery.h@13:de43f28c0365, 2016-06-10 (annotated)
- Committer:
- defrost
- Date:
- Fri Jun 10 14:17:38 2016 +0000
- Revision:
- 13:de43f28c0365
- Parent:
- 12:d9b13f31206d
- Child:
- 17:dc19b3b39790
- File transmission is starting to work, it still does not complete.; - Fixed all of the warnings in the code. Many of them were related to 'regular' string format specifiers being used with 'long' variables. %x -> %llx.
Who changed what in which revision?
User | Revision | Line number | New 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 | 13:de43f28c0365 | 57 | virtual 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 | |
epgmdm | 12:d9b13f31206d | 64 | /** |
epgmdm | 12:d9b13f31206d | 65 | * Returns the max current that can be drawn from the system, in amps |
epgmdm | 12:d9b13f31206d | 66 | */ |
epgmdm | 12:d9b13f31206d | 67 | |
epgmdm | 12:d9b13f31206d | 68 | float getMaxCurrent(); |
epgmdm | 12:d9b13f31206d | 69 | |
epgmdm | 12:d9b13f31206d | 70 | /** |
epgmdm | 12:d9b13f31206d | 71 | * returns a string of the log directory |
epgmdm | 12:d9b13f31206d | 72 | */ |
epgmdm | 12:d9b13f31206d | 73 | char *getLogDirectory(); |
epgmdm | 12:d9b13f31206d | 74 | |
defrost | 5:57b06b4b47c6 | 75 | |
defrost | 5:57b06b4b47c6 | 76 | protected: |
defrost | 5:57b06b4b47c6 | 77 | // ********************** |
defrost | 5:57b06b4b47c6 | 78 | // * Protected variables: * |
defrost | 5:57b06b4b47c6 | 79 | // ********************** |
defrost | 5:57b06b4b47c6 | 80 | /** |
defrost | 5:57b06b4b47c6 | 81 | * Name of log directory, include last / |
defrost | 5:57b06b4b47c6 | 82 | */ |
defrost | 5:57b06b4b47c6 | 83 | |
adrienBiz | 8:0acda4f2e0a8 | 84 | char count; |
adrienBiz | 8:0acda4f2e0a8 | 85 | char* txFileName; |
defrost | 5:57b06b4b47c6 | 86 | |
adrienBiz | 8:0acda4f2e0a8 | 87 | char* fullTxFilePath; |
defrost | 5:57b06b4b47c6 | 88 | |
adrienBiz | 8:0acda4f2e0a8 | 89 | int sizeRead; |
adrienBiz | 8:0acda4f2e0a8 | 90 | unsigned int fileLength; |
adrienBiz | 8:0acda4f2e0a8 | 91 | unsigned int filePointer; |
adrienBiz | 8:0acda4f2e0a8 | 92 | unsigned int fileLeft; |
adrienBiz | 8:0acda4f2e0a8 | 93 | char *sdBuffer; |
adrienBiz | 8:0acda4f2e0a8 | 94 | unsigned int sdBuffPnt; |
defrost | 5:57b06b4b47c6 | 95 | /** |
defrost | 5:57b06b4b47c6 | 96 | * Open channel address of the locker |
defrost | 5:57b06b4b47c6 | 97 | */ |
adrienBiz | 8:0acda4f2e0a8 | 98 | long long openAddr; |
defrost | 5:57b06b4b47c6 | 99 | |
defrost | 5:57b06b4b47c6 | 100 | /** |
defrost | 5:57b06b4b47c6 | 101 | * Private channel address of the locker |
defrost | 5:57b06b4b47c6 | 102 | */ |
adrienBiz | 8:0acda4f2e0a8 | 103 | long long privateAddr; |
defrost | 5:57b06b4b47c6 | 104 | |
adrienBiz | 8:0acda4f2e0a8 | 105 | unsigned int countSD; |
defrost | 5:57b06b4b47c6 | 106 | |
defrost | 5:57b06b4b47c6 | 107 | // ********************** |
defrost | 5:57b06b4b47c6 | 108 | // * Protected flags: * |
defrost | 5:57b06b4b47c6 | 109 | // ********************** |
adrienBiz | 8:0acda4f2e0a8 | 110 | volatile char * flag; |
adrienBiz | 8:0acda4f2e0a8 | 111 | volatile char checkedIn; |
adrienBiz | 8:0acda4f2e0a8 | 112 | volatile char flagGetTime; |
adrienBiz | 8:0acda4f2e0a8 | 113 | volatile char flagNextFile; |
adrienBiz | 8:0acda4f2e0a8 | 114 | volatile char flagSendFileName; |
adrienBiz | 8:0acda4f2e0a8 | 115 | volatile char flagSendFileSize; |
adrienBiz | 8:0acda4f2e0a8 | 116 | volatile char flagSendFile; |
adrienBiz | 8:0acda4f2e0a8 | 117 | volatile char flagSendFileDone; |
epgmdm | 12:d9b13f31206d | 118 | volatile char flagGetMaxCharge; |
epgmdm | 12:d9b13f31206d | 119 | volatile char sendingFile; |
defrost | 5:57b06b4b47c6 | 120 | |
defrost | 5:57b06b4b47c6 | 121 | |
defrost | 5:57b06b4b47c6 | 122 | // ********************** |
defrost | 5:57b06b4b47c6 | 123 | // * Protected interrupts: * |
defrost | 5:57b06b4b47c6 | 124 | // ********************** |
adrienBiz | 8:0acda4f2e0a8 | 125 | InterruptIn* button; |
adrienBiz | 8:0acda4f2e0a8 | 126 | Ticker* txWatch; |
adrienBiz | 8:0acda4f2e0a8 | 127 | Timeout* delay; |
defrost | 5:57b06b4b47c6 | 128 | |
defrost | 5:57b06b4b47c6 | 129 | // ********************** |
defrost | 5:57b06b4b47c6 | 130 | // * Protected functions: * |
defrost | 5:57b06b4b47c6 | 131 | // ********************** |
defrost | 5:57b06b4b47c6 | 132 | /** |
defrost | 5:57b06b4b47c6 | 133 | * Checks in the battery to the locker |
defrost | 5:57b06b4b47c6 | 134 | * Acknowledge received. |
defrost | 5:57b06b4b47c6 | 135 | * Changes the TX pipe address to private |
defrost | 5:57b06b4b47c6 | 136 | * |
defrost | 5:57b06b4b47c6 | 137 | */ |
defrost | 5:57b06b4b47c6 | 138 | void doCheckIn(); |
defrost | 5:57b06b4b47c6 | 139 | /** |
defrost | 5:57b06b4b47c6 | 140 | * Checks out the battery from the locker |
defrost | 5:57b06b4b47c6 | 141 | * Acknowledge received. |
defrost | 5:57b06b4b47c6 | 142 | * Changes the TX pipe address to open |
defrost | 5:57b06b4b47c6 | 143 | * |
defrost | 5:57b06b4b47c6 | 144 | */ |
defrost | 5:57b06b4b47c6 | 145 | void doCheckOut(); |
defrost | 5:57b06b4b47c6 | 146 | /** |
defrost | 5:57b06b4b47c6 | 147 | * sends a request for time update. |
defrost | 5:57b06b4b47c6 | 148 | */ |
epgmdm | 12:d9b13f31206d | 149 | void requestTime(); |
defrost | 5:57b06b4b47c6 | 150 | /** |
defrost | 5:57b06b4b47c6 | 151 | * Sets the value pointed to by flag to 1. |
defrost | 5:57b06b4b47c6 | 152 | */ |
defrost | 5:57b06b4b47c6 | 153 | |
defrost | 5:57b06b4b47c6 | 154 | void nextFileToTx(); |
defrost | 5:57b06b4b47c6 | 155 | void sendDirName(); |
defrost | 5:57b06b4b47c6 | 156 | void sendFileName(); |
defrost | 5:57b06b4b47c6 | 157 | void sendFileSize(); |
defrost | 5:57b06b4b47c6 | 158 | void sendFile(); |
defrost | 5:57b06b4b47c6 | 159 | void sendFileDone(); |
defrost | 5:57b06b4b47c6 | 160 | void setFlag(); |
defrost | 5:57b06b4b47c6 | 161 | /** |
defrost | 5:57b06b4b47c6 | 162 | * Retransmits the last data. |
defrost | 5:57b06b4b47c6 | 163 | * |
defrost | 5:57b06b4b47c6 | 164 | */ |
defrost | 5:57b06b4b47c6 | 165 | void retransmit(); |
defrost | 5:57b06b4b47c6 | 166 | |
defrost | 5:57b06b4b47c6 | 167 | |
defrost | 5:57b06b4b47c6 | 168 | /** |
defrost | 5:57b06b4b47c6 | 169 | * called when the nrf the button is pressed |
defrost | 5:57b06b4b47c6 | 170 | * |
defrost | 5:57b06b4b47c6 | 171 | */ |
defrost | 5:57b06b4b47c6 | 172 | void intButton(); |
defrost | 5:57b06b4b47c6 | 173 | /** |
defrost | 5:57b06b4b47c6 | 174 | * called when the nrf creates an interrupt. |
defrost | 5:57b06b4b47c6 | 175 | * |
defrost | 5:57b06b4b47c6 | 176 | */ |
defrost | 5:57b06b4b47c6 | 177 | void intNrf(); |
defrost | 5:57b06b4b47c6 | 178 | |
epgmdm | 12:d9b13f31206d | 179 | /** |
epgmdm | 12:d9b13f31206d | 180 | * sends a request for time update. |
epgmdm | 12:d9b13f31206d | 181 | */ |
epgmdm | 12:d9b13f31206d | 182 | void requestMaxCharge(); |
epgmdm | 12:d9b13f31206d | 183 | |
defrost | 5:57b06b4b47c6 | 184 | private: |
defrost | 5:57b06b4b47c6 | 185 | // ********************** |
defrost | 5:57b06b4b47c6 | 186 | // * Private variables: * |
defrost | 5:57b06b4b47c6 | 187 | // ********************** |
defrost | 5:57b06b4b47c6 | 188 | |
adrienBiz | 8:0acda4f2e0a8 | 189 | volatile bool maxRT; |
defrost | 5:57b06b4b47c6 | 190 | |
epgmdm | 12:d9b13f31206d | 191 | |
defrost | 5:57b06b4b47c6 | 192 | }; |
defrost | 5:57b06b4b47c6 | 193 | #endif |