summaryrefslogtreecommitdiff
path: root/pyserial/serial/serialjava.py
blob: f7601ecad810bfd44bc23075d562575edbc34057 (plain)
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
#!/usr/bin/env python
#module for serial IO for Jython and JavaComm
#see serial.py
#
#(C) 2002 Chris Liechti <cliechti@gmx.net>
# this is distributed under a free software license, see license.txt

import sys, os, string, javax.comm

VERSION = string.split("$Revision: 1.1.1.1 $")[1]     #extract CVS version

PARITY_NONE, PARITY_EVEN, PARITY_ODD, PARITY_MARK, PARITY_SPACE = (0,1,2,3,4)
STOPBITS_ONE, STOPBITS_TWO, STOPBITS_ONE_HALVE = (1, 2, 3)
FIVEBITS, SIXBITS, SEVENBITS, EIGHTBITS = (5,6,7,8)


portNotOpenError = ValueError('port not open')

def device(portnumber):
    enum = javax.comm.CommPortIdentifier.getPortIdentifiers()
    ports = []
    while enum.hasMoreElements():
        el = enum.nextElement()
        if el.getPortType() == javax.comm.CommPortIdentifier.PORT_SERIAL:
            ports.append(el)
    return ports[portnumber]

class Serial:
    def __init__(self,
                 port,                  #number of device, numbering starts at
                                        #zero. if everything fails, the user
                                        #can specify a device string, note
                                        #that this isn't portable anymore
                 baudrate=9600,         #baudrate
                 bytesize=EIGHTBITS,    #number of databits
                 parity=PARITY_NONE,    #enable parity checking
                 stopbits=STOPBITS_ONE, #number of stopbits
                 timeout=None,          #set a timeout value, None for waiting forever
                 xonxoff=0,             #enable software flow control
                 rtscts=0,              #enable RTS/CTS flow control
                 ):

        if type(port) == type(''):      #strings are taken directly
            portId = javax.comm.CommPortIdentifier.getPortIdentifier(port)
        else:
            portId = device(port)     #numbers are transformed to a comportid obj
        self.portstr = portId.getName()
        
        self.sPort = portId.open("python serial module", 10)
        self.instream = self.sPort.getInputStream()
        self.outstream = self.sPort.getOutputStream()
        self.sPort.enableReceiveTimeout(30)
        if bytesize == FIVEBITS:
            databits = javax.comm.SerialPort.DATABITS_5
        elif bytesize == SIXBITS:
            databits = javax.comm.SerialPort.DATABITS_6
        elif bytesize == SEVENBITS:
            databits = javax.comm.SerialPort.DATABITS_7
        elif bytesize == EIGHTBITS:
            databits = javax.comm.SerialPort.DATABITS_8
        else:
            raise ValueError, "unsupported bytesize"
        
        if stopbits == STOPBITS_ONE:
            jstopbits = javax.comm.SerialPort.STOPBITS_1
        elif stopbits == STOPBITS_ONE_HALVE:
            jstopbits = javax.comm.SerialPort.STOPBITS_1_5
        elif stopbits == STOPBITS_TWO:
            jstopbits = javax.comm.SerialPort.STOPBITS_2
        else:
            raise ValueError, "unsupported number of stopbits"

        if parity == PARITY_NONE:
            jparity = javax.comm.SerialPort.PARITY_NONE
        elif parity == PARITY_EVEN:
            jparity = javax.comm.SerialPort.PARITY_EVEN
        elif parity == PARITY_ODD:
            jparity = javax.comm.SerialPort.PARITY_ODD
        elif parity == PARITY_MARK:
            jparity = javax.comm.SerialPort.PARITY_MARK
        elif parity == PARITY_SPACE:
            jparity = javax.comm.SerialPort.PARITY_SPACE
        else:
            raise ValueError, "unsupported parity type"

        jflowin = jflowout = 0
        if rtscts:
            jflowin = jflowin | javax.comm.SerialPort.FLOWCONTROL_RTSCTS_IN 
            jflowout = jflowout | javax.comm.SerialPort.FLOWCONTROL_RTSCTS_OUT
        if xonxoff:
            jflowin = jflowin | javax.comm.SerialPort.FLOWCONTROL_XONXOFF_IN
            jflowout = jflowout | javax.comm.SerialPort.FLOWCONTROL_XONXOFF_OUT
        
        self.sPort.setSerialPortParams(baudrate, databits, jstopbits, jparity)
        self.sPort.setFlowControlMode(jflowin | jflowout)
        
        self.timeout = timeout
        if timeout:
            self.sPort.enableReceiveTimeout(timeout*1000)
        else:
            self.sPort.disableReceiveTimeout()


    def close(self):
        if self.sPort:
            self.instream.close()
            self.outstream.close()
            self.sPort.close()
            self.sPort = None

    def inWaiting(self):
        if not self.sPort: raise portNotOpenError
        return self.instream.available()

    def write(self, data):
        if not self.sPort: raise portNotOpenError
        self.outstream.write(data)

    def read(self, size=1):
        if not self.sPort: raise portNotOpenError
        res = ''
        while len(res) < size:
            x = self.instream.read()
            if x == -1:
                if self.timeout:
                    break
            else:
                res = res + chr(x)
        return res

    def flushInput(self):
        if not self.sPort: raise portNotOpenError
        self.instream.skip(self.instream.available())

    def flushOutput(self):
        if not self.sPort: raise portNotOpenError
        self.outstream.flush()

    def sendBreak(self):
        if not self.sPort: raise portNotOpenError
        self.sPort.sendBreak()

    def getDSR(self):
        if not self.sPort: raise portNotOpenError
        self.sPort.isDSR()

    def getCD(self):
        if not self.sPort: raise portNotOpenError
        self.sPort.isCD()

    def getRI(self):
        if not self.sPort: raise portNotOpenError
        self.sPort.isRI()

    def getCTS(self):
        if not self.sPort: raise portNotOpenError
        self.sPort.isCTS()

    def setDTR(self,on=1):
        if not self.sPort: raise portNotOpenError
        self.sPort.setDTR(on)

    def setRTS(self,on=1):
        if not self.sPort: raise portNotOpenError
        self.sPort.setRTS(on)

if __name__ == '__main__':
    s = Serial(0,
                 baudrate=19200,        #baudrate
                 bytesize=EIGHTBITS,    #number of databits
                 parity=PARITY_EVEN,    #enable parity checking
                 stopbits=STOPBITS_ONE, #number of stopbits
                 timeout=3,             #set a timeout value, None for waiting forever
                 xonxoff=0,             #enable software flow control
                 rtscts=0,              #enable RTS/CTS flow control
               )
    s.setRTS(1)
    s.setDTR(1)
    s.flushInput()
    s.flushOutput()
    s.write('hello')
    print repr(s.read(5))
    print s.inWaiting()
    del s