annotate README.txt @ 1:7251d615ca5a default tip

Added tag 0.0.1a for changeset 2d587ea676bf
author Ben Croston <ben@croston.org>
date Mon, 03 Sep 2012 17:18:55 +0100
parents 2d587ea676bf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
1 This package enables communication between Python and Scratch using the
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
2 remote sensors feature of Scratch.
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
3
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
4 Remember to enable remote sensors in Scratch! To do this:
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
5
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
6 1. Go to Sensing
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
7 2. Right-click on a 'sensor value'
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
8 3. Select 'enable remote sensor connections'
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
9
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
10 Example usage:
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
11
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
12 ::
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
13
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
14 import scratch
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
15 s = scratch.Scratch()
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
16
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
17 # to make a broadcast to scratch
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
18 s.broadcast("from python")
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
19
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
20 # to receive an update from scratch
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
21 message = s.receive()
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
22 # blocks until an update is received
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
23 # message returned as {'broadcast': [], 'sensor-update': {'scratchvar': '64'}}
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
24 # or {'broadcast': ['from scratch'], 'sensor-update': {}}
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
25 # where scratchvar is the name of a variable in scratch
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
26 # and 'from scratch' is the name of a scratch broadcast
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
27
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
28 # send sensor updates to scratch
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
29 data = {}
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
30 data['pyvar'] = 123
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
31 for data['pycounter'] in range(60):
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
32 s.sensorupdate(data)
2d587ea676bf Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
33