Jan Wolfsberger / 4-20mA_T_Click_Board_Driver

Software to control a 4-20mA T Click Board over SPI

CurrentLoop.h@3:d3f53d46ddeb, 2015-12-09 (annotated)

Committer:
wolfsberger
Date:
Wed Dec 09 08:01:32 2015 +0000
Revision:
3:d3f53d46ddeb
Parent:
2:2ff3e18bc668 
Fixed documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
wolfsberger 0:540e657ddab4 1 #include "mbed.h"
wolfsberger 0:540e657ddab4 2
wolfsberger 0:540e657ddab4 3 /** Class to drive the 4-20mA T Click TM Board
wolfsberger 0:540e657ddab4 4 * Example usage:
wolfsberger 0:540e657ddab4 5 * @code
wolfsberger 1:92b1c9d2751e 6 *
wolfsberger 0:540e657ddab4 7 * #include "mbed.h"
wolfsberger 1:92b1c9d2751e 8 * #include "CurrentLoop.h"
wolfsberger 1:92b1c9d2751e 9 *
wolfsberger 3:d3f53d46ddeb 10 * CurrentLoop loop(SPI_MOSI, SPI_SCK, SPI_CS);
wolfsberger 1:92b1c9d2751e 11 *
wolfsberger 0:540e657ddab4 12 * int main()
wolfsberger 0:540e657ddab4 13 * {
wolfsberger 0:540e657ddab4 14 * loop.output(16.5f);
wolfsberger 1:92b1c9d2751e 15 * while(1);
wolfsberger 0:540e657ddab4 16 * }
wolfsberger 0:540e657ddab4 17 * @endcode
wolfsberger 0:540e657ddab4 18 */
wolfsberger 0:540e657ddab4 19 class CurrentLoop
wolfsberger 0:540e657ddab4 20 {
wolfsberger 0:540e657ddab4 21 public:
wolfsberger 0:540e657ddab4 22 /** Creates an instance of the CurrentLoop class
wolfsberger 3:d3f53d46ddeb 23 * @param mosi Mosi pin
wolfsberger 3:d3f53d46ddeb 24 * @param sck SCK pin
wolfsberger 3:d3f53d46ddeb 25 * @param cs Chip select pin
wolfsberger 0:540e657ddab4 26 */
wolfsberger 2:2ff3e18bc668 27 CurrentLoop(PinName mosi, PinName sck, PinName cs);
wolfsberger 1:92b1c9d2751e 28
wolfsberger 0:540e657ddab4 29 /** Tells the board to outut the given current
wolfsberger 0:540e657ddab4 30 * @param current Current to output. Range: 4.0f to 20.0f
wolfsberger 1:92b1c9d2751e 31 */
wolfsberger 0:540e657ddab4 32 void output(float current);
wolfsberger 0:540e657ddab4 33 private:
wolfsberger 2:2ff3e18bc668 34 SPI spi_;
wolfsberger 2:2ff3e18bc668 35 DigitalOut cs_;
wolfsberger 0:540e657ddab4 36 };