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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module reprap.snap</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="reprap.html"><font color="#ffffff">reprap</font></a>.snap</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.5/site-packages/reprap/snap.py">/usr/lib/python2.5/site-packages/reprap/snap.py</a></font></td></tr></table>
<p><tt>This module is an implementation of the SNAP communications protocol and is used for<br>
communications between the PC host and the RepRap machine.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="exceptions.html">exceptions</a><br>
</td><td width="25%" valign=top><a href="serial.html">serial</a><br>
</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
</td><td width="25%" valign=top><a href="time.html">time</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="reprap.snap.html#Packet">Packet</a>
</font></dt><dt><font face="helvetica, arial"><a href="threading.html#Thread">threading.Thread</a>(<a href="threading.html#_Verbose">threading._Verbose</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="reprap.snap.html#PacketReceiver">PacketReceiver</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Packet">class <strong>Packet</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>SNAP packet class<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Packet-__init__"><strong>__init__</strong></a>(self, DAB<font color="#909090">=None</font>, SAB<font color="#909090">=None</font>, ACK<font color="#909090">=None</font>, NAK<font color="#909090">=None</font>, dataBytes<font color="#909090">=None</font>)</dt><dd><tt>Create SNAP packet</tt></dd></dl>
<dl><dt><a name="Packet-checkReply"><strong>checkReply</strong></a>(self, expectedBytes, expectedCommand)</dt></dl>
<dl><dt><a name="Packet-getReply"><strong>getReply</strong></a>(self)</dt></dl>
<dl><dt><a name="Packet-printPacket"><strong>printPacket</strong></a>(self, status)</dt><dd><tt>Print contents of packet to screen</tt></dd></dl>
<dl><dt><a name="Packet-send"><strong>send</strong></a>(self)</dt><dd><tt>Send SNAP packet over serial conneciton (automatically encodes)</tt></dd></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="PacketReceiver">class <strong>PacketReceiver</strong></a>(<a href="threading.html#Thread">threading.Thread</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt><a href="threading.html#Thread">Thread</a> for recieving packets. Passes on irrelivent packets and buffers those intended for host<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="reprap.snap.html#PacketReceiver">PacketReceiver</a></dd>
<dd><a href="threading.html#Thread">threading.Thread</a></dd>
<dd><a href="threading.html#_Verbose">threading._Verbose</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PacketReceiver-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-clearPackets"><strong>clearPackets</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-getPacket"><strong>getPacket</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-run"><strong>run</strong></a>(self)</dt><dd><tt>Main receiver loop. Do not call this function, call <a href="#PacketReceiver">PacketReceiver</a>.<a href="#PacketReceiver-start">start</a>() to start the function in a new thread</tt></dd></dl>
<dl><dt><a name="PacketReceiver-terminate"><strong>terminate</strong></a>(self)</dt><dd><tt>Terminate reciver thread</tt></dd></dl>
<hr>
Methods inherited from <a href="threading.html#Thread">threading.Thread</a>:<br>
<dl><dt><a name="PacketReceiver-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-getName"><strong>getName</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-isAlive"><strong>isAlive</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-isDaemon"><strong>isDaemon</strong></a>(self)</dt></dl>
<dl><dt><a name="PacketReceiver-join"><strong>join</strong></a>(self, timeout<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="PacketReceiver-setDaemon"><strong>setDaemon</strong></a>(self, daemonic)</dt></dl>
<dl><dt><a name="PacketReceiver-setName"><strong>setName</strong></a>(self, name)</dt></dl>
<dl><dt><a name="PacketReceiver-start"><strong>start</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="threading.html#_Verbose">threading._Verbose</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-closeSerial"><strong>closeSerial</strong></a>()</dt><dd><tt>Close serial port for SNAP RepRap communications</tt></dd></dl>
<dl><dt><a name="-openSerial"><strong>openSerial</strong></a>(port<font color="#909090">=0</font>, rate<font color="#909090">=19200</font>, tout<font color="#909090">=60</font>)</dt><dd><tt>Open serial port for SNAP RepRap communications</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>HDB1_OFFSET</strong> = 2<br>
<strong>PAYLOAD_OFFSET</strong> = 5<br>
<strong>Receiver</strong> = None<br>
<strong>SYNC_BYTE</strong> = 84<br>
<strong>__author__</strong> = 'Stefan Blanke (greenarrow) (greenarrow@users.sourceforge.net)'<br>
<strong>__licence__</strong> = '<font color="#c040c0">\n</font>pyRepRap is free software: you can redistribute...ap. If not, see <http://www.gnu.org/licenses/>.<font color="#c040c0">\n</font>'<br>
<strong>__license__</strong> = 'GPL 3.0'<br>
<strong>localAddress</strong> = 0<br>
<strong>printIncoming</strong> = False<br>
<strong>printOutgoing</strong> = False<br>
<strong>serialPort</strong> = None</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">Stefan Blanke (greenarrow) (greenarrow@users.sourceforge.net)</td></tr></table>
</body></html>
|
