new port configuration dialog fo wxPython

design file for wxGlade is provided too

2 files changed, 515 insertions, 0 deletions

diff --git a/pyserial/examples/wxSerialConfigDialog.py b/pyserial/examples/wxSerialConfigDialog.py
new file mode 100644
index 0000000..9cd3358
--- /dev/null
+++ b/pyserial/examples/wxSerialConfigDialog.py
@@ -0,0 +1,253 @@
+#!/usr/bin/env python
+# generated by wxGlade 0.3.1 on Thu Oct 02 23:25:44 2003
+
+from wxPython.wx import *
+import serial
+
+SHOW_BAUDRATE   = 1<<0
+SHOW_FORMAT     = 1<<1
+SHOW_FLOW       = 1<<2
+SHOW_TIMEOUT    = 1<<3
+SHOW_ALL = SHOW_BAUDRATE|SHOW_FORMAT|SHOW_FLOW|SHOW_TIMEOUT
+
+class SerialConfigDialog(wxDialog):
+    """Serial Port confiuration dialog, to be used with pyserial 2.0+
+       When instantiating a class of this dialog, then the "serial" keyword
+       argument is mandatory. It is a reference to a serial.Serial instance.
+       the optional "show" keyword argument can be used to show/hide different
+       settings. The default is SHOW_ALL which coresponds to 
+       SHOW_BAUDRATE|SHOW_FORMAT|SHOW_FLOW|SHOW_TIMEOUT. All constants can be
+       found in ths module (not the class)."""
+    
+    def __init__(self, *args, **kwds):
+        #grab the serial keyword and remove it from the dict
+        self.serial = kwds['serial']
+        del kwds['serial']
+        self.show = SHOW_ALL
+        if kwds.has_key('show'):
+            self.show = kwds['show']
+            del kwds['show']
+        # begin wxGlade: SerialConfigDialog.__init__
+        # end wxGlade
+        kwds["style"] = wxDEFAULT_DIALOG_STYLE
+        wxDialog.__init__(self, *args, **kwds)
+        self.label_2 = wxStaticText(self, -1, "Port")
+        self.combo_box_port = wxComboBox(self, -1, choices=["dummy1", "dummy2", "dummy3", "dummy4", "dummy5"], style=wxCB_DROPDOWN)
+        if self.show & SHOW_BAUDRATE:
+            self.label_1 = wxStaticText(self, -1, "Baudrate")
+            self.choice_baudrate = wxChoice(self, -1, choices=["choice 1"])
+        if self.show & SHOW_FORMAT:
+            self.label_3 = wxStaticText(self, -1, "Data Bits")
+            self.choice_databits = wxChoice(self, -1, choices=["choice 1"])
+            self.label_4 = wxStaticText(self, -1, "Stop Bits")
+            self.choice_stopbits = wxChoice(self, -1, choices=["choice 1"])
+            self.label_5 = wxStaticText(self, -1, "Parity")
+            self.choice_parity = wxChoice(self, -1, choices=["choice 1"])
+        if self.show & SHOW_TIMEOUT:
+            self.checkbox_timeout = wxCheckBox(self, -1, "Use Timeout")
+            self.text_ctrl_timeout = wxTextCtrl(self, -1, "")
+            self.label_6 = wxStaticText(self, -1, "seconds")
+        if self.show & SHOW_FLOW:
+            self.checkbox_rtscts = wxCheckBox(self, -1, "RTS/CTS")
+            self.checkbox_xonxoff = wxCheckBox(self, -1, "Xon/Xoff")
+        self.button_ok = wxButton(self, -1, "OK")
+        self.button_cancel = wxButton(self, -1, "Cancel")
+
+        self.__set_properties()
+        self.__do_layout()
+        #fill in ports and select current setting
+        index = 0
+        self.combo_box_port.Clear()
+        for n in range(4):
+            portname = serial.device(n)
+            self.combo_box_port.Append(portname)
+            if self.serial.portstr == portname:
+                index = n
+        if self.serial.portstr is not None:
+            self.combo_box_port.SetValue(str(self.serial.portstr))
+        else:
+            self.combo_box_port.SetSelection(index)
+        if self.show & SHOW_BAUDRATE:
+            #fill in badrates and select current setting
+            self.choice_baudrate.Clear()
+            for n, baudrate in enumerate(self.serial.BAUDRATES):
+                self.choice_baudrate.Append(str(baudrate))
+                if self.serial.baudrate == baudrate:
+                    index = n
+            self.choice_baudrate.SetSelection(index)
+        if self.show & SHOW_FORMAT:
+            #fill in databits and select current setting
+            self.choice_databits.Clear()
+            for n, bytesize in enumerate(self.serial.BYTESIZES):
+                self.choice_databits.Append(str(bytesize))
+                if self.serial.bytesize == bytesize:
+                    index = n
+            self.choice_databits.SetSelection(index)
+            #fill in stopbits and select current setting
+            self.choice_stopbits.Clear()
+            for n, stopbits in enumerate(self.serial.STOPBITS):
+                self.choice_stopbits.Append(str(stopbits))
+                if self.serial.stopbits == stopbits:
+                    index = n
+            self.choice_stopbits.SetSelection(index)
+            #fill in parities and select current setting
+            self.choice_parity.Clear()
+            for n, parity in enumerate(self.serial.PARITIES):
+                self.choice_parity.Append(str(serial.PARITY_NAMES[parity]))
+                if self.serial.parity == parity:
+                    index = n
+            self.choice_parity.SetSelection(index)
+        if self.show & SHOW_TIMEOUT:
+            #set the timeout mode and value
+            if self.serial.timeout is None:
+                self.checkbox_timeout.SetValue(False)
+                self.text_ctrl_timeout.Enable(False)
+            else:
+                self.checkbox_timeout.SetValue(True)
+                self.text_ctrl_timeout.Enable(True)
+                self.text_ctrl_timeout.SetValue(str(self.serial.timeout))
+        if self.show & SHOW_FLOW:
+            #set the rtscts mode
+            self.checkbox_rtscts.SetValue(self.serial.rtscts)
+            #set the rtscts mode
+            self.checkbox_xonxoff.SetValue(self.serial.xonxoff)
+        #attach the event handlers
+        self.__attach_events()
+
+    def __set_properties(self):
+        # begin wxGlade: SerialConfigDialog.__set_properties
+        # end wxGlade
+        self.SetTitle("Serial Port Configuration")
+        if self.show & SHOW_TIMEOUT:
+            self.text_ctrl_timeout.Enable(0)
+        self.button_ok.SetDefault()
+
+    def __do_layout(self):
+        # begin wxGlade: SerialConfigDialog.__do_layout
+        # end wxGlade
+        sizer_2 = wxBoxSizer(wxVERTICAL)
+        sizer_3 = wxBoxSizer(wxHORIZONTAL)
+        sizer_basics = wxStaticBoxSizer(wxStaticBox(self, -1, "Basics"), wxVERTICAL)
+        sizer_5 = wxBoxSizer(wxHORIZONTAL)
+        sizer_5.Add(self.label_2, 1, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+        sizer_5.Add(self.combo_box_port, 1, 0, 0)
+        sizer_basics.Add(sizer_5, 0, wxRIGHT|wxEXPAND, 0)
+        if self.show & SHOW_BAUDRATE:
+            sizer_baudrate = wxBoxSizer(wxHORIZONTAL)
+            sizer_baudrate.Add(self.label_1, 1, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_baudrate.Add(self.choice_baudrate, 1, wxALIGN_RIGHT, 0)
+            sizer_basics.Add(sizer_baudrate, 0, wxEXPAND, 0)
+        sizer_2.Add(sizer_basics, 0, wxEXPAND, 0)
+        if self.show & SHOW_FORMAT:
+            sizer_8 = wxBoxSizer(wxHORIZONTAL)
+            sizer_7 = wxBoxSizer(wxHORIZONTAL)
+            sizer_6 = wxBoxSizer(wxHORIZONTAL)
+            sizer_format = wxStaticBoxSizer(wxStaticBox(self, -1, "Data Format"), wxVERTICAL)
+            sizer_6.Add(self.label_3, 1, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_6.Add(self.choice_databits, 1, wxALIGN_RIGHT, 0)
+            sizer_format.Add(sizer_6, 0, wxEXPAND, 0)
+            sizer_7.Add(self.label_4, 1, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_7.Add(self.choice_stopbits, 1, wxALIGN_RIGHT, 0)
+            sizer_format.Add(sizer_7, 0, wxEXPAND, 0)
+            sizer_8.Add(self.label_5, 1, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_8.Add(self.choice_parity, 1, wxALIGN_RIGHT, 0)
+            sizer_format.Add(sizer_8, 0, wxEXPAND, 0)
+            sizer_2.Add(sizer_format, 0, wxEXPAND, 0)
+        if self.show & SHOW_TIMEOUT:
+            sizer_timeout = wxStaticBoxSizer(wxStaticBox(self, -1, "Timeout"), wxHORIZONTAL)
+            sizer_timeout.Add(self.checkbox_timeout, 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_timeout.Add(self.text_ctrl_timeout, 0, 0, 0)
+            sizer_timeout.Add(self.label_6, 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_2.Add(sizer_timeout, 0, 0, 0)
+        if self.show & SHOW_FLOW:
+            sizer_flow = wxStaticBoxSizer(wxStaticBox(self, -1, "Flow Control"), wxHORIZONTAL)
+            sizer_flow.Add(self.checkbox_rtscts, 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_flow.Add(self.checkbox_xonxoff, 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
+            sizer_flow.Add(10, 10, 1, wxEXPAND, 0)
+            sizer_2.Add(sizer_flow, 0, wxEXPAND, 0)
+        sizer_3.Add(self.button_ok, 0, 0, 0)
+        sizer_3.Add(self.button_cancel, 0, 0, 0)
+        sizer_2.Add(sizer_3, 0, wxALL|wxALIGN_RIGHT, 4)
+        self.SetAutoLayout(1)
+        self.SetSizer(sizer_2)
+        sizer_2.Fit(self)
+        sizer_2.SetSizeHints(self)
+        self.Layout()
+
+    def __attach_events(self):
+        EVT_BUTTON(self, self.button_ok.GetId(), self.OnOK)
+        EVT_BUTTON(self, self.button_cancel.GetId(), self.OnCancel)
+        if self.show & SHOW_TIMEOUT:
+            EVT_CHECKBOX(self, self.checkbox_timeout.GetId(), self.OnTimeout)
+
+    def OnOK(self, events):
+        success = True
+        self.serial.port     = str(self.combo_box_port.GetValue())
+        if self.show & SHOW_BAUDRATE:
+            self.serial.baudrate = self.serial.BAUDRATES[self.choice_baudrate.GetSelection()]
+        if self.show & SHOW_FORMAT:
+            self.serial.bytesize = self.serial.BYTESIZES[self.choice_databits.GetSelection()]
+            self.serial.stopbits = self.serial.STOPBITS[self.choice_stopbits.GetSelection()]
+            self.serial.parity   = self.serial.PARITIES[self.choice_parity.GetSelection()]
+        if self.show & SHOW_FLOW:
+            self.serial.rtscts   = self.checkbox_rtscts.GetValue()
+            self.serial.xonxoff  = self.checkbox_xonxoff.GetValue()
+        if self.show & SHOW_TIMEOUT:
+            if self.checkbox_timeout.GetValue():
+                try:
+                    self.serial.timeout = float(self.text_ctrl_timeout.GetValue())
+                except ValueError:
+                    dlg = wxMessageDialog(self, 'Timeout must be a numeric value',
+                                                'Value Error', wxOK | wxICON_ERROR)
+                    dlg.ShowModal()
+                    dlg.Destroy()
+                    success = False
+            else:
+                self.serial.timeout = None
+        if success:
+            self.EndModal(wxID_OK)
+
+    def OnCancel(self, events):
+        self.EndModal(wxID_CANCEL)
+
+    def OnTimeout(self, events):
+        if self.checkbox_timeout.GetValue():
+            self.text_ctrl_timeout.Enable(True)
+        else:
+            self.text_ctrl_timeout.Enable(False)
+
+# end of class SerialConfigDialog
+
+
+class MyApp(wxApp):
+    """Test code"""
+    def OnInit(self):
+        wxInitAllImageHandlers()
+        
+        ser = serial.Serial()
+        print ser
+        #loop until cancel is pressed, old values are used as start for the next run
+        #show the different views, one after the other
+        #value are kept.
+        for flags in (SHOW_BAUDRATE, SHOW_FLOW, SHOW_FORMAT, SHOW_TIMEOUT, SHOW_ALL):
+            dialog_serial_cfg = SerialConfigDialog(None, -1, "", serial=ser, show=flags)
+            self.SetTopWindow(dialog_serial_cfg)
+            result = dialog_serial_cfg.ShowModal()
+            print ser
+            if result != wxID_OK:
+                break
+        #the user can play around with the values, CANCEL aborts the loop
+        while 1:
+            dialog_serial_cfg = SerialConfigDialog(None, -1, "", serial=ser)
+            self.SetTopWindow(dialog_serial_cfg)
+            result = dialog_serial_cfg.ShowModal()
+            print ser
+            if result != wxID_OK:
+                break
+        return 0
+
+# end of class MyApp
+
+if __name__ == "__main__":
+    app = MyApp(0)
+    app.MainLoop()
diff --git a/pyserial/examples/wxSerialConfigDialog.wxg b/pyserial/examples/wxSerialConfigDialog.wxg
new file mode 100644
index 0000000..f5e92e0
--- /dev/null
+++ b/pyserial/examples/wxSerialConfigDialog.wxg
@@ -0,0 +1,262 @@
+<?xml version="1.0"?>
+<!-- generated by wxGlade 0.3.1 on Fri Oct 03 01:53:04 2003 -->
+
+<application path="D:\prog\python\pyserial_sf\pyserial\examples\wxSerialConfigDialog.py" name="app" class="MyApp" option="0" language="python" top_window="dialog_serial_cfg" encoding="ISO-8859-1" use_gettext="0" overwrite="0">
+    <object class="SerialConfigDialog" name="dialog_serial_cfg" base="EditDialog">
+        <style>wxDEFAULT_DIALOG_STYLE</style>
+        <title>Serial Port Configuration</title>
+        <object class="wxBoxSizer" name="sizer_2" base="EditBoxSizer">
+            <orient>wxVERTICAL</orient>
+            <object class="sizeritem">
+                <flag>wxEXPAND</flag>
+                <border>0</border>
+                <option>0</option>
+                <object class="wxStaticBoxSizer" name="sizer_basics" base="EditStaticBoxSizer">
+                    <orient>wxVERTICAL</orient>
+                    <label>Basics</label>
+                    <object class="sizeritem">
+                        <flag>wxRIGHT|wxEXPAND</flag>
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxBoxSizer" name="sizer_5" base="EditBoxSizer">
+                            <orient>wxHORIZONTAL</orient>
+                            <object class="sizeritem">
+                                <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                                <border>4</border>
+                                <option>1</option>
+                                <object class="wxStaticText" name="label_2" base="EditStaticText">
+                                    <attribute>1</attribute>
+                                    <label>Port</label>
+                                </object>
+                            </object>
+                            <object class="sizeritem">
+                                <border>0</border>
+                                <option>1</option>
+                                <object class="wxComboBox" name="combo_box_port" base="EditComboBox">
+                                    <selection>0</selection>
+                                    <choices>
+                                        <choice>dummy1</choice>
+                                        <choice>dummy2</choice>
+                                        <choice>dummy3</choice>
+                                        <choice>dummy4</choice>
+                                        <choice>dummy5</choice>
+                                    </choices>
+                                </object>
+                            </object>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxEXPAND</flag>
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxBoxSizer" name="sizer_baudrate" base="EditBoxSizer">
+                            <orient>wxHORIZONTAL</orient>
+                            <object class="sizeritem">
+                                <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                                <border>4</border>
+                                <option>1</option>
+                                <object class="wxStaticText" name="label_1" base="EditStaticText">
+                                    <attribute>1</attribute>
+                                    <label>Baudrate</label>
+                                </object>
+                            </object>
+                            <object class="sizeritem">
+                                <flag>wxALIGN_RIGHT</flag>
+                                <border>0</border>
+                                <option>1</option>
+                                <object class="wxChoice" name="choice_baudrate" base="EditChoice">
+                                    <selection>0</selection>
+                                    <choices>
+                                        <choice>choice 1</choice>
+                                    </choices>
+                                </object>
+                            </object>
+                        </object>
+                    </object>
+                </object>
+            </object>
+            <object class="sizeritem">
+                <flag>wxEXPAND</flag>
+                <border>0</border>
+                <option>0</option>
+                <object class="wxStaticBoxSizer" name="sizer_format" base="EditStaticBoxSizer">
+                    <orient>wxVERTICAL</orient>
+                    <label>Data Format</label>
+                    <object class="sizeritem">
+                        <flag>wxEXPAND</flag>
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxBoxSizer" name="sizer_6" base="EditBoxSizer">
+                            <orient>wxHORIZONTAL</orient>
+                            <object class="sizeritem">
+                                <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                                <border>4</border>
+                                <option>1</option>
+                                <object class="wxStaticText" name="label_3" base="EditStaticText">
+                                    <attribute>1</attribute>
+                                    <label>Data Bits</label>
+                                </object>
+                            </object>
+                            <object class="sizeritem">
+                                <flag>wxALIGN_RIGHT</flag>
+                                <border>0</border>
+                                <option>1</option>
+                                <object class="wxChoice" name="choice_databits" base="EditChoice">
+                                    <selection>0</selection>
+                                    <choices>
+                                        <choice>choice 1</choice>
+                                    </choices>
+                                </object>
+                            </object>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxEXPAND</flag>
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxBoxSizer" name="sizer_7" base="EditBoxSizer">
+                            <orient>wxHORIZONTAL</orient>
+                            <object class="sizeritem">
+                                <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                                <border>4</border>
+                                <option>1</option>
+                                <object class="wxStaticText" name="label_4" base="EditStaticText">
+                                    <attribute>1</attribute>
+                                    <label>Stop Bits</label>
+                                </object>
+                            </object>
+                            <object class="sizeritem">
+                                <flag>wxALIGN_RIGHT</flag>
+                                <border>0</border>
+                                <option>1</option>
+                                <object class="wxChoice" name="choice_stopbits" base="EditChoice">
+                                    <selection>0</selection>
+                                    <choices>
+                                        <choice>choice 1</choice>
+                                    </choices>
+                                </object>
+                            </object>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxEXPAND</flag>
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxBoxSizer" name="sizer_8" base="EditBoxSizer">
+                            <orient>wxHORIZONTAL</orient>
+                            <object class="sizeritem">
+                                <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                                <border>4</border>
+                                <option>1</option>
+                                <object class="wxStaticText" name="label_5" base="EditStaticText">
+                                    <attribute>1</attribute>
+                                    <label>Parity</label>
+                                </object>
+                            </object>
+                            <object class="sizeritem">
+                                <flag>wxALIGN_RIGHT</flag>
+                                <border>0</border>
+                                <option>1</option>
+                                <object class="wxChoice" name="choice_parity" base="EditChoice">
+                                    <selection>0</selection>
+                                    <choices>
+                                        <choice>choice 1</choice>
+                                    </choices>
+                                </object>
+                            </object>
+                        </object>
+                    </object>
+                </object>
+            </object>
+            <object class="sizeritem">
+                <border>0</border>
+                <option>0</option>
+                <object class="wxStaticBoxSizer" name="sizer_timeout" base="EditStaticBoxSizer">
+                    <orient>wxHORIZONTAL</orient>
+                    <label>Timeout</label>
+                    <object class="sizeritem">
+                        <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                        <border>4</border>
+                        <option>0</option>
+                        <object class="wxCheckBox" name="checkbox_timeout" base="EditCheckBox">
+                            <label>Use Timeout</label>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxTextCtrl" name="text_ctrl_timeout" base="EditTextCtrl">
+                            <disabled>1</disabled>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                        <border>4</border>
+                        <option>0</option>
+                        <object class="wxStaticText" name="label_6" base="EditStaticText">
+                            <attribute>1</attribute>
+                            <label>seconds</label>
+                        </object>
+                    </object>
+                </object>
+            </object>
+            <object class="sizeritem">
+                <flag>wxEXPAND</flag>
+                <border>0</border>
+                <option>0</option>
+                <object class="wxStaticBoxSizer" name="sizer_flow" base="EditStaticBoxSizer">
+                    <orient>wxHORIZONTAL</orient>
+                    <label>Flow Control</label>
+                    <object class="sizeritem">
+                        <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                        <border>4</border>
+                        <option>0</option>
+                        <object class="wxCheckBox" name="checkbox_rtscts" base="EditCheckBox">
+                            <label>RTS/CTS</label>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxALL|wxALIGN_CENTER_VERTICAL</flag>
+                        <border>4</border>
+                        <option>0</option>
+                        <object class="wxCheckBox" name="checkbox_xonxoff" base="EditCheckBox">
+                            <label>Xon/Xoff</label>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <flag>wxEXPAND</flag>
+                        <border>0</border>
+                        <option>1</option>
+                        <object class="spacer" name="spacer" base="EditSpacer">
+                            <height>10</height>
+                            <width>10</width>
+                        </object>
+                    </object>
+                </object>
+            </object>
+            <object class="sizeritem">
+                <flag>wxALL|wxALIGN_RIGHT</flag>
+                <border>4</border>
+                <option>0</option>
+                <object class="wxBoxSizer" name="sizer_3" base="EditBoxSizer">
+                    <orient>wxHORIZONTAL</orient>
+                    <object class="sizeritem">
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxButton" name="button_ok" base="EditButton">
+                            <default>1</default>
+                            <label>OK</label>
+                        </object>
+                    </object>
+                    <object class="sizeritem">
+                        <border>0</border>
+                        <option>0</option>
+                        <object class="wxButton" name="button_cancel" base="EditButton">
+                            <label>Cancel</label>
+                        </object>
+                    </object>
+                </object>
+            </object>
+        </object>
+    </object>
+</application>