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

Files at this revision

API Documentation at this revision

Comitter:
MichaelW
Date:
Sat Jan 23 22:28:00 2016 +0000
Parent:
8:682c65afe534
Child:
10:9d82e28ffaea
Commit message:
Updated to new RPC code; The original versions of RPCFunction and RPCVariable have been removed to rely on the versions now in the official mbed-rpc library.

Changed in this revision

RPCFunction.cpp Show diff for this revision Revisions of this file
RPCFunction.h Show diff for this revision Revisions of this file
RPCVariable.h Show diff for this revision Revisions of this file
SerialRPCInterface.cpp Show annotated file Show diff for this revision Revisions of this file
mbed-rpc.lib Show annotated file Show diff for this revision Revisions of this file
--- a/RPCFunction.cpp	Sat Jan 28 19:12:00 2012 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,115 +0,0 @@
- /**
-* @section LICENSE
-*Copyright (c) 2010 ARM Ltd.
-*
-*Permission is hereby granted, free of charge, to any person obtaining a copy
-*of this software and associated documentation files (the "Software"), to deal
-*in the Software without restriction, including without limitation the rights
-*to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-*copies of the Software, and to permit persons to whom the Software is
-*furnished to do so, subject to the following conditions:
-* 
-*The above copyright notice and this permission notice shall be included in
-*all copies or substantial portions of the Software.
-* 
-*THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-*IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-*FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-*AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-*LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-*OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-*THE SOFTWARE.
-*
-* @section Description
-*This class provides an object which can be called over RPC to run the function which is attached to it.
-*
-*/      
-#include "RPCFunction.h"
-#include "rpc.h"
-
-//Parse a char argument without delimiting by anything that is non alphanumeric - based on version in rpc.h line 153
- char *parse_arg_char(const char *arg, const char **next) {
-        const char *ptr = arg;
-        char *res = NULL;
-        if(*arg == '"') {
-            /* quoted string */
-            ptr = ++arg;
-            int len = 0;
-            /* find the end (and length) of the quoted string */
-            for(char c = *ptr; c != 0 && c != '"'; c = *++ptr) {
-                len++;
-                if(c == '\\') {
-                    ptr++;
-                }
-            }  
-            /* copy the quoted string, and unescape characters */
-            if(len != 0) {
-                res = new char[len+1];
-                char *resptr = res;
-                while(arg != ptr) {
-                    *resptr++ = parse_char(arg, &arg);
-                }
-                *resptr = 0;
-            }
-        } else {
-            /* unquoted string */
-            while(isalnum(*ptr) || isgraph(*ptr) || *ptr=='_' || *ptr == ' ') {             //Edit this line to change which types of characters are allowed and which delimit
-                ptr++;
-           }
-            int len = ptr-arg;
-            if(len!=0) {                                //Chnages made to just pass whole string with no next arg or delimiters, these changes just removes space at the beginning
-                res = new char[len];                    //was len+1
-                memcpy(res, arg + 1, len - 1);          // was arg, len
-                res[len-1] = 0;                         //was len 
-            }
-        }
-      
-        if(next != NULL) {
-            *next = ptr;
-        } 
-      return res;
-    }  
-    
-    //Custom rpc method caller for execute so that the string will not be delimited by anything
-    //See line 436 of rpc.h
-    void rpc_method_caller_run(Base *this_ptr, const char *arguments, char *result) {
-    
-        const char *next = arguments;
-        char* arg1 = parse_arg_char(next,NULL);
-        
-        char * res = (static_cast<RPCFunction*>(this_ptr)->run)(arg1);
-        if(result != NULL) {
-            write_result<char*>(res, result);
-        }
-        delete arg1;    // Seems to stop a memory leak issue which prevented an RPCFunction being run more than ~500 times
-    }
-
-   RPCFunction::RPCFunction(void(*f)(char*, char*), const char* name) : Base(name){
-        _ftr = f;   
-    }
-    
-
-    //Just run the attached function using the string thats in private memory - or just using null values, 
-    char * RPCFunction::run(char * input){
-        strcpy(_input, input);
-        (*_ftr)(_input,_output);
-        return(_output);
-    }
-    
-    //Just read the output string
-    char* RPCFunction::read(){
-        return(_output);
-    }
-    
-    
-    #ifdef MBED_RPC
-    const rpc_method *RPCFunction::get_rpc_methods() {
-       static const rpc_method rpc_methods[] = { 
-        { "run", rpc_method_caller_run },                                                 //Run using custom caller, all characters accepted in string
-        { "read", rpc_method_caller<char*, RPCFunction, &RPCFunction::read> },
-        RPC_METHOD_SUPER(Base)
-      };
-      return rpc_methods;
-    }       
-
-#endif
--- a/RPCFunction.h	Sat Jan 28 19:12:00 2012 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,84 +0,0 @@
- /**
-* @section LICENSE
-*Copyright (c) 2010 ARM Ltd.
-*
-*Permission is hereby granted, free of charge, to any person obtaining a copy
-*of this software and associated documentation files (the "Software"), to deal
-*in the Software without restriction, including without limitation the rights
-*to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-*copies of the Software, and to permit persons to whom the Software is
-*furnished to do so, subject to the following conditions:
-* 
-*The above copyright notice and this permission notice shall be included in
-*all copies or substantial portions of the Software.
-* 
-*THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-*IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-*FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-*AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-*LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-*OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-*THE SOFTWARE.
-* 
-* @section Description
-*This class provides an object which can be called over RPC to run the function which is attached to it.
-* 
-*/     
-#ifndef RPCFUNCTION_RPC
-#define RPCFUNCTION_RPC
-/**
-*Includes
-*/
-#include "mbed.h"
-#include "platform.h"
-#include "rpc.h"
-#define STR_LEN 64
-#include "platform.h"
- 
-#ifdef MBED_RPC
-#include "rpc.h"
-#endif
-/**
-*
-*Class to call custom functions over RPC
-*
-*/
-class RPCFunction : public Base{
-public:
-    /**
-    * Constructor
-    * 
-    *@param f Pointer to the function to call. the function must be of the form void foo(char * input, char * output)
-    *@param name The name of this object
-    */
-    RPCFunction(void(*f)(char*, char*), const char* = NULL);
-
-    /** 
-    *run 
-    *
-    *Calls the attached function passing the string in but doesn't return the result.
-    *@param str The string to be passed into the attached function. This string can consist of any ASCII characters apart from escape codes. The usual limtations on argument content for RPC strings has been removed
-    *@return A string output from the function
-    */
-    char * run(char* str);
-    
-    /**
-    *Reads the value of the output string.
-    *
-    *@returns the string outputted from the last time the function was called
-    */
-    char * read();
-
-
-     #ifdef MBED_RPC
-    virtual const struct rpc_method *get_rpc_methods();      
-     #endif
-
-private:
-    void (*_ftr)(char*, char*);
-    
-    char _input[STR_LEN];
-    char _output[STR_LEN];
-    
-};
-#endif
\ No newline at end of file
--- a/RPCVariable.h	Sat Jan 28 19:12:00 2012 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,102 +0,0 @@
- /**
-* @section LICENSE
-*Copyright (c) 2010 ARM Ltd.
-*
-*Permission is hereby granted, free of charge, to any person obtaining a copy
-*of this software and associated documentation files (the "Software"), to deal
-*in the Software without restriction, including without limitation the rights
-*to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-*copies of the Software, and to permit persons to whom the Software is
-*furnished to do so, subject to the following conditions:
-* 
-*The above copyright notice and this permission notice shall be included in
-*all copies or substantial portions of the Software.
-* 
-*THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-*IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-*FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-*AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-*LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-*OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-*THE SOFTWARE.
-*
-* @section Description
-*This class provides an object to which a variable can be attached. Any type 
-*for which a parse_args function specilisation exists can be attached. This includes 
-*all of the standard types.
-*
-*/
- #ifndef RPCVARIABLE_H_  
- #define RPCVARIABLE_H_
-
-#include "mbed.h"
-#include "platform.h"
-#include "rpc.h"
- /**
- *Class to read and set an attached variable using the RPC
- *
- */
-template<class T>
-class RPCVariable : public Base{
-public:
-    /**
-    * Constructor
-    * 
-    *@param ptr Pointer to the variable to make accessible over RPC. Any type of 
-    *variable can be connected
-    *@param name The name of that this object will be over RPC
-    */
-    template<class A>
-    RPCVariable(A * ptr, const char * name) : Base(name){
-        _ptr = ptr;
-    }
-    /**
-    *Read the variable over RPC.
-    * 
-    *@return The value of the variable
-    */
-    T read(){
-        return(*_ptr);
-    }
-    /**
-    *Write a value to the variable over RPC
-    * 
-    *@param The value to be written to the attached variable.
-    */
-    void write(T value){
-        *_ptr = value;
-    }
-
-                                                                                   #ifdef MBED_RPC
-    virtual const struct rpc_method *get_rpc_methods();    
-    static struct rpc_class *get_rpc_class();
-                     #endif
-
-private:
-    T * _ptr;
-                                           
-};
-
-//Set up RPC methods
-#ifdef MBED_RPC
-template <class T>
-    const rpc_method *RPCVariable<T>::get_rpc_methods() {
-       static const rpc_method rpc_methods[] = {
-        { "read", rpc_method_caller<T, RPCVariable, &RPCVariable::read> },
-        { "write", rpc_method_caller<RPCVariable, T, &RPCVariable::write> },
-        RPC_METHOD_SUPER(Base)
-      };
-      return rpc_methods;
-    }       
-    template <class T>
-    rpc_class *RPCVariable<T>::get_rpc_class() {
-        static const rpc_function funcs[] = {"new", rpc_function_caller<const char*, T,const char* , &Base::construct<RemoteVar, T ,const char*> >,RPC_METHOD_END};
-        static rpc_class c = { "RPCVariable", funcs, NULL };
-        return &c;
-    }
-#endif
-
-//There could be specialisation for integer, to also give increment and decrements
-
-
-#endif  //RPCVARIABLE_H_
\ No newline at end of file
--- a/SerialRPCInterface.cpp	Sat Jan 28 19:12:00 2012 +0000
+++ b/SerialRPCInterface.cpp	Sat Jan 23 22:28:00 2016 +0000
@@ -24,6 +24,8 @@
 * @section DESCRIPTION
 *
 *This class sets up RPC communication. This allows objects on mbed to be controlled. Objects can be created or existing objects can be used
+*
+* Substantially updated Jan 2016 to work with the updated RPC system
 */
 #include "SerialRPCInterface.h"
 
@@ -38,6 +40,7 @@
 }
 
 void SerialRPCInterface::_RegClasses(void){
+    /*
     //Register classes with base 
     Base::add_rpc_class<AnalogIn>();
     Base::add_rpc_class<DigitalIn>();
@@ -54,6 +57,7 @@
     #if !defined(TARGET_LPC11U24) 
     Base::add_rpc_class<AnalogOut>();
     #endif
+    */
 }
 
 void SerialRPCInterface::Disable(void){
@@ -64,7 +68,7 @@
 }
 void SerialRPCInterface::_MsgProcess(void) {
     if(_enabled == true){
-        rpc(_command, _response);
+        RPC::call(_command, _response);
     }
 }
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-rpc.lib	Sat Jan 23 22:28:00 2016 +0000
@@ -0,0 +1,1 @@
+http://developer.mbed.org/teams/mbed/code/mbed-rpc/#325e3da833e1