File: README.md

package info (click to toggle)
python-autobahn 0.14.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,132 kB
  • ctags: 3,069
  • sloc: python: 18,460; makefile: 285; sh: 3
file content (59 lines) | stat: -rw-r--r-- 2,243 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Bridging an Arduino to WebSocket/WAMP

This demo shows how to hook up an Arduino to a WAMP router and display real-time sensor readings in a browser, as well as control the Arduino from the browser.

To give you an idea, here are some videos:

* [Arduino Yun + Browser](https://www.youtube.com/watch?v=Egvu4jL_Wlo)
* [Arduino Mega + Browser](https://www.youtube.com/watch?v=va7j86thW5M)


## How it works

The `serial2ws` program will open a serial port connection with your Arduino. It will communicate over a simple, ASCII based protocol with your device.

### Control

The `serial2ws` program exposes a WAMP procedure `com.myapp.mcu.control_led` which can be called remotely via WAMP. When the procedure is called, `serial2py` forwards the control command to the Arduino over serial. Turning on and off the LED is done by sending a `0` or `1` character over serial.

### Sense

The Arduino will send sensor analog values by sending ASCII lines over serial consisting of the sensor ID (int) and sensor value (int) delimited by whitespace (a tab character). The `serial2ws` will receive those lines, parse each line, and then publish WAMP events with the payload consisting of the sensor values to the topic `com.myapp.mcu.on_analog_value`.


## How to run

You will need to have the following installed onn the host that connects over serial to your Arduino. 

* Python
* Twisted
* AutobahnPython
* PySerial

> When using the Arduino Yun, this stuff runs on the little Linux computer that resides on the Yun. When using the Arduino Mega, this stuff runs on a computer to which you connect the Mega via serial.

Upload the `serial2ws.ino` sketch to your Arduino.

Connect your serial device and run

    python serial2ws.py

Open

    http://localhost:8000/

in your browser.

> The `serial2ws` program has a number of command line options for setting COM port, baudrate etc.
> Run `python serial2ws.py --help` to get information on those.


**Examples**

Arduino Yun running an embedded Web server and WAMP router:

	python serial2ws.py --port /dev/ttyATH0

Arduino Yun running disabling the embedded Web server and connecting to an uplink WAMP router:

	python serial2ws.py --port /dev/ttyATH0 --web 0 --router ws://192.168.1.130:8080/ws