Michael Walker / RPCInterface

Library to provide a mechanism to make it easier to add RPC to custom code by using RPCFunction and RPCVariable objects. Also includes a class to receive and process RPC over serial.

Dependencies:   mbed-rpc

Dependents:   GSL_10-Pololu_A4983_STEPMOTORDRIVER Protodrive RPC_HTTP RPC_TestHack ... more

SerialRPCInterface.h@10:9d82e28ffaea, 2016-03-14 (annotated)

Committer:
MichaelW
Date:
Mon Mar 14 18:05:38 2016 +0000
Revision:
10:9d82e28ffaea
Parent:
5:56fd0b265aba 
Added adding RPC classes so that new objects can be created ver RPC; ; Not all the classes which were originally supported are still supported and there is an issue with the AnalogIn and AnalogOut so these are not supported here yet

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MichaelW 5:56fd0b265aba 1 /**
MichaelW 5:56fd0b265aba 2 * @section LICENSE
MichaelW 5:56fd0b265aba 3 *Copyright (c) 2010 ARM Ltd.
MichaelW 5:56fd0b265aba 4 *
MichaelW 5:56fd0b265aba 5 *Permission is hereby granted, free of charge, to any person obtaining a copy
MichaelW 5:56fd0b265aba 6 *of this software and associated documentation files (the "Software"), to deal
MichaelW 5:56fd0b265aba 7 *in the Software without restriction, including without limitation the rights
MichaelW 5:56fd0b265aba 8 *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
MichaelW 5:56fd0b265aba 9 *copies of the Software, and to permit persons to whom the Software is
MichaelW 5:56fd0b265aba 10 *furnished to do so, subject to the following conditions:
MichaelW 5:56fd0b265aba 11 *
MichaelW 5:56fd0b265aba 12 *The above copyright notice and this permission notice shall be included in
MichaelW 5:56fd0b265aba 13 *all copies or substantial portions of the Software.
MichaelW 5:56fd0b265aba 14 *
MichaelW 5:56fd0b265aba 15 *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
MichaelW 5:56fd0b265aba 16 *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
MichaelW 5:56fd0b265aba 17 *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
MichaelW 5:56fd0b265aba 18 *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
MichaelW 5:56fd0b265aba 19 *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
MichaelW 5:56fd0b265aba 20 *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
MichaelW 5:56fd0b265aba 21 *THE SOFTWARE.
MichaelW 5:56fd0b265aba 22 *
MichaelW 5:56fd0b265aba 23 *
MichaelW 5:56fd0b265aba 24 * @section DESCRIPTION
MichaelW 5:56fd0b265aba 25 *
MichaelW 5:56fd0b265aba 26 *This class sets up RPC communication over serial.
MichaelW 5:56fd0b265aba 27 */
MichaelW 5:56fd0b265aba 28 #ifndef INTERFACE
MichaelW 5:56fd0b265aba 29 #define INTERFACE
MichaelW 5:56fd0b265aba 30
MichaelW 5:56fd0b265aba 31 /**
MichaelW 5:56fd0b265aba 32 *Includes
MichaelW 5:56fd0b265aba 33 */
MichaelW 5:56fd0b265aba 34 #include "mbed.h"
MichaelW 5:56fd0b265aba 35 #include "platform.h"
MichaelW 5:56fd0b265aba 36 #include "rpc.h"
MichaelW 10:9d82e28ffaea 37 #include "RpcClasses.h"
MichaelW 5:56fd0b265aba 38 #include "RPCFunction.h"
MichaelW 5:56fd0b265aba 39 #include "RPCVariable.h"
MichaelW 5:56fd0b265aba 40
MichaelW 5:56fd0b265aba 41
MichaelW 5:56fd0b265aba 42 namespace mbed{
MichaelW 5:56fd0b265aba 43 /**
MichaelW 5:56fd0b265aba 44 *Provides an Interface to mbed over RPC.
MichaelW 5:56fd0b265aba 45 *
MichaelW 5:56fd0b265aba 46 *For the chosen communication type this class sets up the necessary interrupts to receive RPC messages. Receives the messages, passes them to the rpc function and then returns the result.
MichaelW 5:56fd0b265aba 47 */
MichaelW 5:56fd0b265aba 48 class SerialRPCInterface{
MichaelW 5:56fd0b265aba 49 public:
MichaelW 5:56fd0b265aba 50 /**
MichaelW 5:56fd0b265aba 51 *Constructor
MichaelW 5:56fd0b265aba 52 *
MichaelW 5:56fd0b265aba 53 *Sets up RPC communication using serial communication.
MichaelW 5:56fd0b265aba 54 *
MichaelW 5:56fd0b265aba 55 *@param tx The transmit pin of the serial port.
MichaelW 5:56fd0b265aba 56 *@param rx The receive pin of the serial port.
MichaelW 5:56fd0b265aba 57 *@param baud Set the baud rate, default is 9600.
MichaelW 5:56fd0b265aba 58 */
MichaelW 5:56fd0b265aba 59 SerialRPCInterface(PinName tx, PinName rx, int baud = 9600);
MichaelW 5:56fd0b265aba 60
MichaelW 5:56fd0b265aba 61 /**
MichaelW 5:56fd0b265aba 62 *Disable the RPC.
MichaelW 5:56fd0b265aba 63 *
MichaelW 5:56fd0b265aba 64 *This will stop RPC messages being recevied and interpreted by this library. This might be used to prevent RPC commands interrupting an important piece of code on mbed.
MichaelW 5:56fd0b265aba 65 */
MichaelW 5:56fd0b265aba 66 void Disable(void);
MichaelW 5:56fd0b265aba 67
MichaelW 5:56fd0b265aba 68 /**
MichaelW 5:56fd0b265aba 69 *Enable the RPC
MichaelW 5:56fd0b265aba 70 *
MichaelW 5:56fd0b265aba 71 *This will set this class to receiving and executing RPC commands. The class starts in this mode so this function only needs to be called if you have previosuly disabled the RPC.
MichaelW 5:56fd0b265aba 72 *
MichaelW 5:56fd0b265aba 73 */
MichaelW 5:56fd0b265aba 74 void Enable(void);
MichaelW 5:56fd0b265aba 75
MichaelW 5:56fd0b265aba 76 //The Serial Port
MichaelW 5:56fd0b265aba 77 Serial pc;
MichaelW 5:56fd0b265aba 78
MichaelW 5:56fd0b265aba 79
MichaelW 5:56fd0b265aba 80 private:
MichaelW 5:56fd0b265aba 81 //Handle messgaes and take appropriate action
MichaelW 5:56fd0b265aba 82 void _MsgProcess(void);
MichaelW 5:56fd0b265aba 83 void _RegClasses(void);
MichaelW 5:56fd0b265aba 84 void _RPCSerial();
MichaelW 5:56fd0b265aba 85 bool _enabled;
MichaelW 5:56fd0b265aba 86 char _command[256];
MichaelW 5:56fd0b265aba 87 char _response[256];
MichaelW 5:56fd0b265aba 88 bool _RPCflag;
MichaelW 5:56fd0b265aba 89 };
MichaelW 5:56fd0b265aba 90 }
MichaelW 0:9232f9e1178d 91 #endif