Alessandro Angelino / mbed-tools

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-tools by Morpheus

host_tests/mbedrpc.py@0:4a2e5f0422d6, 2016-03-30 (annotated)

Committer:
screamer
Date:
Wed Mar 30 16:23:44 2016 +0000
Revision:
0:4a2e5f0422d6
Initial revision

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:4a2e5f0422d6 1 # mbedRPC.py - mbed RPC interface for Python
screamer 0:4a2e5f0422d6 2 #
screamer 0:4a2e5f0422d6 3 ##Copyright (c) 2010 ARM Ltd
screamer 0:4a2e5f0422d6 4 ##
screamer 0:4a2e5f0422d6 5 ##Permission is hereby granted, free of charge, to any person obtaining a copy
screamer 0:4a2e5f0422d6 6 ##of this software and associated documentation files (the "Software"), to deal
screamer 0:4a2e5f0422d6 7 ##in the Software without restriction, including without limitation the rights
screamer 0:4a2e5f0422d6 8 ##to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
screamer 0:4a2e5f0422d6 9 ##copies of the Software, and to permit persons to whom the Software is
screamer 0:4a2e5f0422d6 10 ##furnished to do so, subject to the following conditions:
screamer 0:4a2e5f0422d6 11 ##
screamer 0:4a2e5f0422d6 12 ##The above copyright notice and this permission notice shall be included in
screamer 0:4a2e5f0422d6 13 ##all copies or substantial portions of the Software.
screamer 0:4a2e5f0422d6 14 ##
screamer 0:4a2e5f0422d6 15 ##THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
screamer 0:4a2e5f0422d6 16 ##IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
screamer 0:4a2e5f0422d6 17 ##FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
screamer 0:4a2e5f0422d6 18 ##AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
screamer 0:4a2e5f0422d6 19 ##LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
screamer 0:4a2e5f0422d6 20 ##OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
screamer 0:4a2e5f0422d6 21 ##THE SOFTWARE.
screamer 0:4a2e5f0422d6 22 #
screamer 0:4a2e5f0422d6 23 # Example:
screamer 0:4a2e5f0422d6 24 # >from mbedRPC import*
screamer 0:4a2e5f0422d6 25 # >mbed = SerialRPC("COM5",9600)
screamer 0:4a2e5f0422d6 26 # >myled = DigitalOut(mbed,"myled") <--- Where the text in quotations matches your RPC pin definition's second parameter, in this case it could be RpcDigitalOut myled(LED1,"myled");
screamer 0:4a2e5f0422d6 27 # >myled.write(1)
screamer 0:4a2e5f0422d6 28 # >
screamer 0:4a2e5f0422d6 29
screamer 0:4a2e5f0422d6 30 import serial, urllib2, time
screamer 0:4a2e5f0422d6 31
screamer 0:4a2e5f0422d6 32 # mbed super class
screamer 0:4a2e5f0422d6 33 class mbed:
screamer 0:4a2e5f0422d6 34 def __init__(self):
screamer 0:4a2e5f0422d6 35 print("This will work as a demo but no transport mechanism has been selected")
screamer 0:4a2e5f0422d6 36
screamer 0:4a2e5f0422d6 37 def rpc(self, name, method, args):
screamer 0:4a2e5f0422d6 38 print("Superclass method not overridden")
screamer 0:4a2e5f0422d6 39
screamer 0:4a2e5f0422d6 40
screamer 0:4a2e5f0422d6 41 # Transport mechanisms, derived from mbed
screamer 0:4a2e5f0422d6 42 class SerialRPC(mbed):
screamer 0:4a2e5f0422d6 43 def __init__(self, port, baud):
screamer 0:4a2e5f0422d6 44 self.ser = serial.Serial(port)
screamer 0:4a2e5f0422d6 45 self.ser.setBaudrate(baud)
screamer 0:4a2e5f0422d6 46
screamer 0:4a2e5f0422d6 47 def rpc(self, name, method, args):
screamer 0:4a2e5f0422d6 48 # creates the command to be sent serially - /name/method arg1 arg2 arg3 ... argN
screamer 0:4a2e5f0422d6 49 str = "/" + name + "/" + method + " " + " ".join(args) + "\n"
screamer 0:4a2e5f0422d6 50 # prints the command being executed
screamer 0:4a2e5f0422d6 51 print str
screamer 0:4a2e5f0422d6 52 # writes the command to serial
screamer 0:4a2e5f0422d6 53 self.ser.write(str)
screamer 0:4a2e5f0422d6 54 # strips trailing characters from the line just written
screamer 0:4a2e5f0422d6 55 ret_val = self.ser.readline().strip()
screamer 0:4a2e5f0422d6 56 return ret_val
screamer 0:4a2e5f0422d6 57
screamer 0:4a2e5f0422d6 58
screamer 0:4a2e5f0422d6 59 class HTTPRPC(mbed):
screamer 0:4a2e5f0422d6 60 def __init__(self, ip):
screamer 0:4a2e5f0422d6 61 self.host = "http://" + ip
screamer 0:4a2e5f0422d6 62
screamer 0:4a2e5f0422d6 63 def rpc(self, name, method, args):
screamer 0:4a2e5f0422d6 64 response = urllib2.urlopen(self.host + "/rpc/" + name + "/" + method + "%20" + "%20".join(args))
screamer 0:4a2e5f0422d6 65 return response.read().strip()
screamer 0:4a2e5f0422d6 66
screamer 0:4a2e5f0422d6 67
screamer 0:4a2e5f0422d6 68 # generic mbed interface super class
screamer 0:4a2e5f0422d6 69 class mbed_interface():
screamer 0:4a2e5f0422d6 70 # initialize an mbed interface with a transport mechanism and pin name
screamer 0:4a2e5f0422d6 71 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 72 self.mbed = this_mbed
screamer 0:4a2e5f0422d6 73 if isinstance(mpin, str):
screamer 0:4a2e5f0422d6 74 self.name = mpin
screamer 0:4a2e5f0422d6 75
screamer 0:4a2e5f0422d6 76 def __del__(self):
screamer 0:4a2e5f0422d6 77 r = self.mbed.rpc(self.name, "delete", [])
screamer 0:4a2e5f0422d6 78
screamer 0:4a2e5f0422d6 79 def new(self, class_name, name, pin1, pin2 = "", pin3 = ""):
screamer 0:4a2e5f0422d6 80 args = [arg for arg in [pin1,pin2,pin3,name] if arg != ""]
screamer 0:4a2e5f0422d6 81 r = self.mbed.rpc(class_name, "new", args)
screamer 0:4a2e5f0422d6 82
screamer 0:4a2e5f0422d6 83 # generic read
screamer 0:4a2e5f0422d6 84 def read(self):
screamer 0:4a2e5f0422d6 85 r = self.mbed.rpc(self.name, "read", [])
screamer 0:4a2e5f0422d6 86 return int(r)
screamer 0:4a2e5f0422d6 87
screamer 0:4a2e5f0422d6 88
screamer 0:4a2e5f0422d6 89 # for classes that need write functionality - inherits from the generic reading interface
screamer 0:4a2e5f0422d6 90 class mbed_interface_write(mbed_interface):
screamer 0:4a2e5f0422d6 91 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 92 mbed_interface.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 93
screamer 0:4a2e5f0422d6 94 # generic write
screamer 0:4a2e5f0422d6 95 def write(self, value):
screamer 0:4a2e5f0422d6 96 r = self.mbed.rpc(self.name, "write", [str(value)])
screamer 0:4a2e5f0422d6 97
screamer 0:4a2e5f0422d6 98
screamer 0:4a2e5f0422d6 99 # mbed interfaces
screamer 0:4a2e5f0422d6 100 class DigitalOut(mbed_interface_write):
screamer 0:4a2e5f0422d6 101 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 102 mbed_interface_write.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 103
screamer 0:4a2e5f0422d6 104
screamer 0:4a2e5f0422d6 105 class AnalogIn(mbed_interface):
screamer 0:4a2e5f0422d6 106 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 107 mbed_interface.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 108
screamer 0:4a2e5f0422d6 109 def read_u16(self):
screamer 0:4a2e5f0422d6 110 r = self.mbed.rpc(self.name, "read_u16", [])
screamer 0:4a2e5f0422d6 111 return int(r)
screamer 0:4a2e5f0422d6 112
screamer 0:4a2e5f0422d6 113
screamer 0:4a2e5f0422d6 114 class AnalogOut(mbed_interface_write):
screamer 0:4a2e5f0422d6 115 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 116 mbed_interface_write.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 117
screamer 0:4a2e5f0422d6 118 def write_u16(self, value):
screamer 0:4a2e5f0422d6 119 self.mbed.rpc(self.name, "write_u16", [str(value)])
screamer 0:4a2e5f0422d6 120
screamer 0:4a2e5f0422d6 121 def read(self):
screamer 0:4a2e5f0422d6 122 r = self.mbed.rpc(self.name, "read", [])
screamer 0:4a2e5f0422d6 123 return float(r)
screamer 0:4a2e5f0422d6 124
screamer 0:4a2e5f0422d6 125
screamer 0:4a2e5f0422d6 126 class DigitalIn(mbed_interface):
screamer 0:4a2e5f0422d6 127 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 128 mbed_interface.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 129
screamer 0:4a2e5f0422d6 130
screamer 0:4a2e5f0422d6 131 class PwmOut(mbed_interface_write):
screamer 0:4a2e5f0422d6 132 def __init__(self, this_mbed, mpin):
screamer 0:4a2e5f0422d6 133 mbed_interface_write.__init__(self, this_mbed, mpin)
screamer 0:4a2e5f0422d6 134
screamer 0:4a2e5f0422d6 135 def read(self):
screamer 0:4a2e5f0422d6 136 r = self.mbed.rpc(self.name, "read", [])
screamer 0:4a2e5f0422d6 137 return r
screamer 0:4a2e5f0422d6 138
screamer 0:4a2e5f0422d6 139 def period(self, value):
screamer 0:4a2e5f0422d6 140 self.mbed.rpc(self.name, "period", [str(value)])
screamer 0:4a2e5f0422d6 141
screamer 0:4a2e5f0422d6 142 def period_ms(self, value):
screamer 0:4a2e5f0422d6 143 self.mbed.rpc(self.name, "period_ms", [str(value)])
screamer 0:4a2e5f0422d6 144
screamer 0:4a2e5f0422d6 145 def period_us(self, value):
screamer 0:4a2e5f0422d6 146 self.mbed.rpc(self.name, "period_us", [str(value)])
screamer 0:4a2e5f0422d6 147
screamer 0:4a2e5f0422d6 148 def pulsewidth(self, value):
screamer 0:4a2e5f0422d6 149 self.mbed.rpc(self.name, "pulsewidth", [str(value)])
screamer 0:4a2e5f0422d6 150
screamer 0:4a2e5f0422d6 151 def pulsewidth_ms(self, value):
screamer 0:4a2e5f0422d6 152 self.mbed.rpc(self.name, "pulsewidth_ms", [str(value)])
screamer 0:4a2e5f0422d6 153
screamer 0:4a2e5f0422d6 154 def pulsewidth_us(self, value):
screamer 0:4a2e5f0422d6 155 self.mbed.rpc(self.name, "pulsewidth_us", [str(value)])
screamer 0:4a2e5f0422d6 156
screamer 0:4a2e5f0422d6 157
screamer 0:4a2e5f0422d6 158 class RPCFunction(mbed_interface):
screamer 0:4a2e5f0422d6 159 def __init__(self, this_mbed, name):
screamer 0:4a2e5f0422d6 160 mbed_interface.__init__(self, this_mbed, name)
screamer 0:4a2e5f0422d6 161
screamer 0:4a2e5f0422d6 162 def run(self, input):
screamer 0:4a2e5f0422d6 163 r = self.mbed.rpc(self.name, "run", [input])
screamer 0:4a2e5f0422d6 164 return r
screamer 0:4a2e5f0422d6 165
screamer 0:4a2e5f0422d6 166
screamer 0:4a2e5f0422d6 167 class RPCVariable(mbed_interface_write):
screamer 0:4a2e5f0422d6 168 def __init__(self, this_mbed, name):
screamer 0:4a2e5f0422d6 169 mbed_interface_write.__init__(self, this_mbed, name)
screamer 0:4a2e5f0422d6 170
screamer 0:4a2e5f0422d6 171 def read(self):
screamer 0:4a2e5f0422d6 172 r = self.mbed.rpc(self.name, "read", [])
screamer 0:4a2e5f0422d6 173 return r
screamer 0:4a2e5f0422d6 174
screamer 0:4a2e5f0422d6 175 class Timer(mbed_interface):
screamer 0:4a2e5f0422d6 176 def __init__(self, this_mbed, name):
screamer 0:4a2e5f0422d6 177 mbed_interface.__init__(self, this_mbed, name)
screamer 0:4a2e5f0422d6 178
screamer 0:4a2e5f0422d6 179 def start(self):
screamer 0:4a2e5f0422d6 180 r = self.mbed.rpc(self.name, "start", [])
screamer 0:4a2e5f0422d6 181
screamer 0:4a2e5f0422d6 182 def stop(self):
screamer 0:4a2e5f0422d6 183 r = self.mbed.rpc(self.name, "stop", [])
screamer 0:4a2e5f0422d6 184
screamer 0:4a2e5f0422d6 185 def reset(self):
screamer 0:4a2e5f0422d6 186 r = self.mbed.rpc(self.name, "reset", [])
screamer 0:4a2e5f0422d6 187
screamer 0:4a2e5f0422d6 188 def read(self):
screamer 0:4a2e5f0422d6 189 r = self.mbed.rpc(self.name, "read", [])
screamer 0:4a2e5f0422d6 190 return float(re.search('\d+\.*\d*', r).group(0))
screamer 0:4a2e5f0422d6 191
screamer 0:4a2e5f0422d6 192 def read_ms(self):
screamer 0:4a2e5f0422d6 193 r = self.mbed.rpc(self.name, "read_ms", [])
screamer 0:4a2e5f0422d6 194 return float(re.search('\d+\.*\d*', r).group(0))
screamer 0:4a2e5f0422d6 195
screamer 0:4a2e5f0422d6 196 def read_us(self):
screamer 0:4a2e5f0422d6 197 r = self.mbed.rpc(self.name, "read_us", [])
screamer 0:4a2e5f0422d6 198 return float(re.search('\d+\.*\d*', r).group(0))
screamer 0:4a2e5f0422d6 199
screamer 0:4a2e5f0422d6 200 # Serial
screamer 0:4a2e5f0422d6 201 class Serial():
screamer 0:4a2e5f0422d6 202 def __init__(self, this_mbed, tx, rx=""):
screamer 0:4a2e5f0422d6 203 self.mbed = this_mbed
screamer 0:4a2e5f0422d6 204 if isinstance(tx, str):
screamer 0:4a2e5f0422d6 205 self.name = tx
screamer 0:4a2e5f0422d6 206
screamer 0:4a2e5f0422d6 207 def __del__(self):
screamer 0:4a2e5f0422d6 208 r = self.mbed.rpc(self.name, "delete", [])
screamer 0:4a2e5f0422d6 209
screamer 0:4a2e5f0422d6 210 def baud(self, value):
screamer 0:4a2e5f0422d6 211 r = self.mbed.rpc(self.name, "baud", [str(value)])
screamer 0:4a2e5f0422d6 212
screamer 0:4a2e5f0422d6 213 def putc(self, value):
screamer 0:4a2e5f0422d6 214 r = self.mbed.rpc(self.name, "putc", [str(value)])
screamer 0:4a2e5f0422d6 215
screamer 0:4a2e5f0422d6 216 def puts(self, value):
screamer 0:4a2e5f0422d6 217 r = self.mbed.rpc(self.name, "puts", ["\"" + str(value) + "\""])
screamer 0:4a2e5f0422d6 218
screamer 0:4a2e5f0422d6 219 def getc(self):
screamer 0:4a2e5f0422d6 220 r = self.mbed.rpc(self.name, "getc", [])
screamer 0:4a2e5f0422d6 221 return int(r)
screamer 0:4a2e5f0422d6 222
screamer 0:4a2e5f0422d6 223
screamer 0:4a2e5f0422d6 224 def wait(s):
screamer 0:4a2e5f0422d6 225 time.sleep(s)