Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/CAN.h@85:0cf65ceb4492, 2019-04-29 (annotated)

Committer:
jwhammel
Date:
Mon Apr 29 04:24:38 2019 +0000
Revision:
85:0cf65ceb4492
Parent:
84:fc8c9b39723a 
We have added an alarm trigger that gets sent to AT&T Flow.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jwhammel 84:fc8c9b39723a 1 /* mbed Microcontroller Library
jwhammel 84:fc8c9b39723a 2 * Copyright (c) 2006-2013 ARM Limited
jwhammel 84:fc8c9b39723a 3 *
jwhammel 84:fc8c9b39723a 4 * Licensed under the Apache License, Version 2.0 (the "License");
jwhammel 84:fc8c9b39723a 5 * you may not use this file except in compliance with the License.
jwhammel 84:fc8c9b39723a 6 * You may obtain a copy of the License at
jwhammel 84:fc8c9b39723a 7 *
jwhammel 84:fc8c9b39723a 8 * http://www.apache.org/licenses/LICENSE-2.0
jwhammel 84:fc8c9b39723a 9 *
jwhammel 84:fc8c9b39723a 10 * Unless required by applicable law or agreed to in writing, software
jwhammel 84:fc8c9b39723a 11 * distributed under the License is distributed on an "AS IS" BASIS,
jwhammel 84:fc8c9b39723a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jwhammel 84:fc8c9b39723a 13 * See the License for the specific language governing permissions and
jwhammel 84:fc8c9b39723a 14 * limitations under the License.
jwhammel 84:fc8c9b39723a 15 */
jwhammel 84:fc8c9b39723a 16 #ifndef MBED_CAN_H
jwhammel 84:fc8c9b39723a 17 #define MBED_CAN_H
jwhammel 84:fc8c9b39723a 18
jwhammel 84:fc8c9b39723a 19 #include "platform.h"
jwhammel 84:fc8c9b39723a 20
jwhammel 84:fc8c9b39723a 21 #if DEVICE_CAN
jwhammel 84:fc8c9b39723a 22
jwhammel 84:fc8c9b39723a 23 #include "can_api.h"
jwhammel 84:fc8c9b39723a 24 #include "can_helper.h"
jwhammel 84:fc8c9b39723a 25 #include "FunctionPointer.h"
jwhammel 84:fc8c9b39723a 26
jwhammel 84:fc8c9b39723a 27 namespace mbed {
jwhammel 84:fc8c9b39723a 28
jwhammel 84:fc8c9b39723a 29 /** CANMessage class
jwhammel 84:fc8c9b39723a 30 */
jwhammel 84:fc8c9b39723a 31 class CANMessage : public CAN_Message {
jwhammel 84:fc8c9b39723a 32
jwhammel 84:fc8c9b39723a 33 public:
jwhammel 84:fc8c9b39723a 34 /** Creates empty CAN message.
jwhammel 84:fc8c9b39723a 35 */
jwhammel 84:fc8c9b39723a 36 CANMessage() : CAN_Message() {
jwhammel 84:fc8c9b39723a 37 len = 8;
jwhammel 84:fc8c9b39723a 38 type = CANData;
jwhammel 84:fc8c9b39723a 39 format = CANStandard;
jwhammel 84:fc8c9b39723a 40 id = 0;
jwhammel 84:fc8c9b39723a 41 memset(data, 0, 8);
jwhammel 84:fc8c9b39723a 42 }
jwhammel 84:fc8c9b39723a 43
jwhammel 84:fc8c9b39723a 44 /** Creates CAN message with specific content.
jwhammel 84:fc8c9b39723a 45 */
jwhammel 84:fc8c9b39723a 46 CANMessage(int _id, const char *_data, char _len = 8, CANType _type = CANData, CANFormat _format = CANStandard) {
jwhammel 84:fc8c9b39723a 47 len = _len & 0xF;
jwhammel 84:fc8c9b39723a 48 type = _type;
jwhammel 84:fc8c9b39723a 49 format = _format;
jwhammel 84:fc8c9b39723a 50 id = _id;
jwhammel 84:fc8c9b39723a 51 memcpy(data, _data, _len);
jwhammel 84:fc8c9b39723a 52 }
jwhammel 84:fc8c9b39723a 53
jwhammel 84:fc8c9b39723a 54 /** Creates CAN remote message.
jwhammel 84:fc8c9b39723a 55 */
jwhammel 84:fc8c9b39723a 56 CANMessage(int _id, CANFormat _format = CANStandard) {
jwhammel 84:fc8c9b39723a 57 len = 0;
jwhammel 84:fc8c9b39723a 58 type = CANRemote;
jwhammel 84:fc8c9b39723a 59 format = _format;
jwhammel 84:fc8c9b39723a 60 id = _id;
jwhammel 84:fc8c9b39723a 61 memset(data, 0, 8);
jwhammel 84:fc8c9b39723a 62 }
jwhammel 84:fc8c9b39723a 63 };
jwhammel 84:fc8c9b39723a 64
jwhammel 84:fc8c9b39723a 65 /** A can bus client, used for communicating with can devices
jwhammel 84:fc8c9b39723a 66 */
jwhammel 84:fc8c9b39723a 67 class CAN {
jwhammel 84:fc8c9b39723a 68
jwhammel 84:fc8c9b39723a 69 public:
jwhammel 84:fc8c9b39723a 70 /** Creates an CAN interface connected to specific pins.
jwhammel 84:fc8c9b39723a 71 *
jwhammel 84:fc8c9b39723a 72 * @param rd read from transmitter
jwhammel 84:fc8c9b39723a 73 * @param td transmit to transmitter
jwhammel 84:fc8c9b39723a 74 *
jwhammel 84:fc8c9b39723a 75 * Example:
jwhammel 84:fc8c9b39723a 76 * @code
jwhammel 84:fc8c9b39723a 77 * #include "mbed.h"
jwhammel 84:fc8c9b39723a 78 *
jwhammel 84:fc8c9b39723a 79 * Ticker ticker;
jwhammel 84:fc8c9b39723a 80 * DigitalOut led1(LED1);
jwhammel 84:fc8c9b39723a 81 * DigitalOut led2(LED2);
jwhammel 84:fc8c9b39723a 82 * CAN can1(p9, p10);
jwhammel 84:fc8c9b39723a 83 * CAN can2(p30, p29);
jwhammel 84:fc8c9b39723a 84 *
jwhammel 84:fc8c9b39723a 85 * char counter = 0;
jwhammel 84:fc8c9b39723a 86 *
jwhammel 84:fc8c9b39723a 87 * void send() {
jwhammel 84:fc8c9b39723a 88 * if(can1.write(CANMessage(1337, &counter, 1))) {
jwhammel 84:fc8c9b39723a 89 * printf("Message sent: %d\n", counter);
jwhammel 84:fc8c9b39723a 90 * counter++;
jwhammel 84:fc8c9b39723a 91 * }
jwhammel 84:fc8c9b39723a 92 * led1 = !led1;
jwhammel 84:fc8c9b39723a 93 * }
jwhammel 84:fc8c9b39723a 94 *
jwhammel 84:fc8c9b39723a 95 * int main() {
jwhammel 84:fc8c9b39723a 96 * ticker.attach(&send, 1);
jwhammel 84:fc8c9b39723a 97 * CANMessage msg;
jwhammel 84:fc8c9b39723a 98 * while(1) {
jwhammel 84:fc8c9b39723a 99 * if(can2.read(msg)) {
jwhammel 84:fc8c9b39723a 100 * printf("Message received: %d\n\n", msg.data[0]);
jwhammel 84:fc8c9b39723a 101 * led2 = !led2;
jwhammel 84:fc8c9b39723a 102 * }
jwhammel 84:fc8c9b39723a 103 * wait(0.2);
jwhammel 84:fc8c9b39723a 104 * }
jwhammel 84:fc8c9b39723a 105 * }
jwhammel 84:fc8c9b39723a 106 * @endcode
jwhammel 84:fc8c9b39723a 107 */
jwhammel 84:fc8c9b39723a 108 CAN(PinName rd, PinName td);
jwhammel 84:fc8c9b39723a 109 virtual ~CAN();
jwhammel 84:fc8c9b39723a 110
jwhammel 84:fc8c9b39723a 111 /** Set the frequency of the CAN interface
jwhammel 84:fc8c9b39723a 112 *
jwhammel 84:fc8c9b39723a 113 * @param hz The bus frequency in hertz
jwhammel 84:fc8c9b39723a 114 *
jwhammel 84:fc8c9b39723a 115 * @returns
jwhammel 84:fc8c9b39723a 116 * 1 if successful,
jwhammel 84:fc8c9b39723a 117 * 0 otherwise
jwhammel 84:fc8c9b39723a 118 */
jwhammel 84:fc8c9b39723a 119 int frequency(int hz);
jwhammel 84:fc8c9b39723a 120
jwhammel 84:fc8c9b39723a 121 /** Write a CANMessage to the bus.
jwhammel 84:fc8c9b39723a 122 *
jwhammel 84:fc8c9b39723a 123 * @param msg The CANMessage to write.
jwhammel 84:fc8c9b39723a 124 *
jwhammel 84:fc8c9b39723a 125 * @returns
jwhammel 84:fc8c9b39723a 126 * 0 if write failed,
jwhammel 84:fc8c9b39723a 127 * 1 if write was successful
jwhammel 84:fc8c9b39723a 128 */
jwhammel 84:fc8c9b39723a 129 int write(CANMessage msg);
jwhammel 84:fc8c9b39723a 130
jwhammel 84:fc8c9b39723a 131 /** Read a CANMessage from the bus.
jwhammel 84:fc8c9b39723a 132 *
jwhammel 84:fc8c9b39723a 133 * @param msg A CANMessage to read to.
jwhammel 84:fc8c9b39723a 134 * @param handle message filter handle (0 for any message)
jwhammel 84:fc8c9b39723a 135 *
jwhammel 84:fc8c9b39723a 136 * @returns
jwhammel 84:fc8c9b39723a 137 * 0 if no message arrived,
jwhammel 84:fc8c9b39723a 138 * 1 if message arrived
jwhammel 84:fc8c9b39723a 139 */
jwhammel 84:fc8c9b39723a 140 int read(CANMessage &msg, int handle = 0);
jwhammel 84:fc8c9b39723a 141
jwhammel 84:fc8c9b39723a 142 /** Reset CAN interface.
jwhammel 84:fc8c9b39723a 143 *
jwhammel 84:fc8c9b39723a 144 * To use after error overflow.
jwhammel 84:fc8c9b39723a 145 */
jwhammel 84:fc8c9b39723a 146 void reset();
jwhammel 84:fc8c9b39723a 147
jwhammel 84:fc8c9b39723a 148 /** Puts or removes the CAN interface into silent monitoring mode
jwhammel 84:fc8c9b39723a 149 *
jwhammel 84:fc8c9b39723a 150 * @param silent boolean indicating whether to go into silent mode or not
jwhammel 84:fc8c9b39723a 151 */
jwhammel 84:fc8c9b39723a 152 void monitor(bool silent);
jwhammel 84:fc8c9b39723a 153
jwhammel 84:fc8c9b39723a 154 enum Mode {
jwhammel 84:fc8c9b39723a 155 Reset = 0,
jwhammel 84:fc8c9b39723a 156 Normal,
jwhammel 84:fc8c9b39723a 157 Silent,
jwhammel 84:fc8c9b39723a 158 LocalTest,
jwhammel 84:fc8c9b39723a 159 GlobalTest,
jwhammel 84:fc8c9b39723a 160 SilentTest
jwhammel 84:fc8c9b39723a 161 };
jwhammel 84:fc8c9b39723a 162
jwhammel 84:fc8c9b39723a 163 /** Change CAN operation to the specified mode
jwhammel 84:fc8c9b39723a 164 *
jwhammel 84:fc8c9b39723a 165 * @param mode The new operation mode (CAN::Normal, CAN::Silent, CAN::LocalTest, CAN::GlobalTest, CAN::SilentTest)
jwhammel 84:fc8c9b39723a 166 *
jwhammel 84:fc8c9b39723a 167 * @returns
jwhammel 84:fc8c9b39723a 168 * 0 if mode change failed or unsupported,
jwhammel 84:fc8c9b39723a 169 * 1 if mode change was successful
jwhammel 84:fc8c9b39723a 170 */
jwhammel 84:fc8c9b39723a 171 int mode(Mode mode);
jwhammel 84:fc8c9b39723a 172
jwhammel 84:fc8c9b39723a 173 /** Filter out incomming messages
jwhammel 84:fc8c9b39723a 174 *
jwhammel 84:fc8c9b39723a 175 * @param id the id to filter on
jwhammel 84:fc8c9b39723a 176 * @param mask the mask applied to the id
jwhammel 84:fc8c9b39723a 177 * @param format format to filter on (Default CANAny)
jwhammel 84:fc8c9b39723a 178 * @param handle message filter handle (Optional)
jwhammel 84:fc8c9b39723a 179 *
jwhammel 84:fc8c9b39723a 180 * @returns
jwhammel 84:fc8c9b39723a 181 * 0 if filter change failed or unsupported,
jwhammel 84:fc8c9b39723a 182 * new filter handle if successful
jwhammel 84:fc8c9b39723a 183 */
jwhammel 84:fc8c9b39723a 184 int filter(unsigned int id, unsigned int mask, CANFormat format = CANAny, int handle = 0);
jwhammel 84:fc8c9b39723a 185
jwhammel 84:fc8c9b39723a 186 /** Returns number of read errors to detect read overflow errors.
jwhammel 84:fc8c9b39723a 187 */
jwhammel 84:fc8c9b39723a 188 unsigned char rderror();
jwhammel 84:fc8c9b39723a 189
jwhammel 84:fc8c9b39723a 190 /** Returns number of write errors to detect write overflow errors.
jwhammel 84:fc8c9b39723a 191 */
jwhammel 84:fc8c9b39723a 192 unsigned char tderror();
jwhammel 84:fc8c9b39723a 193
jwhammel 84:fc8c9b39723a 194 enum IrqType {
jwhammel 84:fc8c9b39723a 195 RxIrq = 0,
jwhammel 84:fc8c9b39723a 196 TxIrq,
jwhammel 84:fc8c9b39723a 197 EwIrq,
jwhammel 84:fc8c9b39723a 198 DoIrq,
jwhammel 84:fc8c9b39723a 199 WuIrq,
jwhammel 84:fc8c9b39723a 200 EpIrq,
jwhammel 84:fc8c9b39723a 201 AlIrq,
jwhammel 84:fc8c9b39723a 202 BeIrq,
jwhammel 84:fc8c9b39723a 203 IdIrq
jwhammel 84:fc8c9b39723a 204 };
jwhammel 84:fc8c9b39723a 205
jwhammel 84:fc8c9b39723a 206 /** Attach a function to call whenever a CAN frame received interrupt is
jwhammel 84:fc8c9b39723a 207 * generated.
jwhammel 84:fc8c9b39723a 208 *
jwhammel 84:fc8c9b39723a 209 * @param fptr A pointer to a void function, or 0 to set as none
jwhammel 84:fc8c9b39723a 210 * @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, CAN::TxIrq for transmitted or aborted, CAN::EwIrq for error warning, CAN::DoIrq for data overrun, CAN::WuIrq for wake-up, CAN::EpIrq for error passive, CAN::AlIrq for arbitration lost, CAN::BeIrq for bus error)
jwhammel 84:fc8c9b39723a 211 */
jwhammel 84:fc8c9b39723a 212 void attach(void (*fptr)(void), IrqType type=RxIrq);
jwhammel 84:fc8c9b39723a 213
jwhammel 84:fc8c9b39723a 214 /** Attach a member function to call whenever a CAN frame received interrupt
jwhammel 84:fc8c9b39723a 215 * is generated.
jwhammel 84:fc8c9b39723a 216 *
jwhammel 84:fc8c9b39723a 217 * @param tptr pointer to the object to call the member function on
jwhammel 84:fc8c9b39723a 218 * @param mptr pointer to the member function to be called
jwhammel 84:fc8c9b39723a 219 * @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
jwhammel 84:fc8c9b39723a 220 */
jwhammel 84:fc8c9b39723a 221 template<typename T>
jwhammel 84:fc8c9b39723a 222 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
jwhammel 84:fc8c9b39723a 223 if((mptr != NULL) && (tptr != NULL)) {
jwhammel 84:fc8c9b39723a 224 _irq[type].attach(tptr, mptr);
jwhammel 84:fc8c9b39723a 225 can_irq_set(&_can, (CanIrqType)type, 1);
jwhammel 84:fc8c9b39723a 226 }
jwhammel 84:fc8c9b39723a 227 else {
jwhammel 84:fc8c9b39723a 228 can_irq_set(&_can, (CanIrqType)type, 0);
jwhammel 84:fc8c9b39723a 229 }
jwhammel 84:fc8c9b39723a 230 }
jwhammel 84:fc8c9b39723a 231
jwhammel 84:fc8c9b39723a 232 static void _irq_handler(uint32_t id, CanIrqType type);
jwhammel 84:fc8c9b39723a 233
jwhammel 84:fc8c9b39723a 234 protected:
jwhammel 84:fc8c9b39723a 235 can_t _can;
jwhammel 84:fc8c9b39723a 236 FunctionPointer _irq[9];
jwhammel 84:fc8c9b39723a 237 };
jwhammel 84:fc8c9b39723a 238
jwhammel 84:fc8c9b39723a 239 } // namespace mbed
jwhammel 84:fc8c9b39723a 240
jwhammel 84:fc8c9b39723a 241 #endif
jwhammel 84:fc8c9b39723a 242
jwhammel 84:fc8c9b39723a 243 #endif // MBED_CAN_H
jwhammel 84:fc8c9b39723a 244