version_2.0
Dependents: cc3000_ping_demo_try_2
Fork of mbed by
Diff: CAN.h
- Revision:
- 55:d722ed6a4237
- Parent:
- 54:71b101360fb9
- Child:
- 59:0883845fe643
--- a/CAN.h Tue Jan 08 12:46:36 2013 +0000 +++ b/CAN.h Wed Jan 16 12:56:34 2013 +0000 @@ -27,7 +27,7 @@ #if DEVICE_CAN #include "can_api.h" -#include "can_helper.h" +#include "can_helper.h" #include "FunctionPointer.h" namespace mbed { @@ -46,7 +46,7 @@ id = 0; memset(data, 0, 8); } - + /** Creates CAN message with specific content. */ CANMessage(int _id, const char *_data, char _len = 8, CANType _type = CANData, CANFormat _format = CANStandard) { @@ -81,23 +81,23 @@ * Example: * @code * #include "mbed.h" - * + * * Ticker ticker; * DigitalOut led1(LED1); * DigitalOut led2(LED2); * CAN can1(p9, p10); * CAN can2(p30, p29); - * + * * char counter = 0; - * + * * void send() { * if(can1.write(CANMessage(1337, &counter, 1))) { * printf("Message sent: %d\n", counter); * counter++; - * } + * } * led1 = !led1; * } - * + * * int main() { * ticker.attach(&send, 1); * CANMessage msg; @@ -105,15 +105,15 @@ * if(can2.read(msg)) { * printf("Message received: %d\n\n", msg.data[0]); * led2 = !led2; - * } + * } * wait(0.2); * } - * } + * } * @endcode */ CAN(PinName rd, PinName td); virtual ~CAN(); - + /** Set the frequency of the CAN interface * * @param hz The bus frequency in hertz @@ -123,7 +123,7 @@ * 0 otherwise */ int frequency(int hz); - + /** Write a CANMessage to the bus. * * @param msg The CANMessage to write. @@ -133,9 +133,9 @@ * 1 if write was successful */ int write(CANMessage msg); - + /** Read a CANMessage from the bus. - * + * * @param msg A CANMessage to read to. * * @returns @@ -143,19 +143,19 @@ * 1 if message arrived */ int read(CANMessage &msg); - + /** Reset CAN interface. * * To use after error overflow. */ void reset(); - + /** Puts or removes the CAN interface into silent monitoring mode * * @param silent boolean indicating whether to go into silent mode or not */ void monitor(bool silent); - + /** Returns number of read errors to detect read overflow errors. */ unsigned char rderror(); @@ -170,7 +170,7 @@ * @param fptr A pointer to a void function, or 0 to set as none */ void attach(void (*fptr)(void)); - + /** Attach a member function to call whenever a CAN frame received interrupt * is generated. * @@ -186,11 +186,11 @@ remove_interrupt(); } } - + private: can_t _can; FunctionPointer _rxirq; - + void setup_interrupt(void); void remove_interrupt(void); };