general cleanup of the examples

felixdivo · felixdivo · commit fab6f23a8ea5 · 2018-02-22T17:47:55.000+01:00
diff --git a/examples/cyclic.py b/examples/cyclic.py
@@ -1,4 +1,6 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 This example exercises the periodic sending capabilities.
 
@@ -8,6 +10,8 @@
 
 """
 
+from __future__ import print_function
+
 import logging
 import time
 
@@ -125,5 +129,4 @@ def test_periodic_send_with_modifying_data(bus):
 
         bus.shutdown()
 
-
     time.sleep(2)
diff --git a/examples/send_one.py b/examples/send_one.py
@@ -1,20 +1,31 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This example shows how sending a single message works.
+"""
+
 from __future__ import print_function
-import can
 
+import can
 
 def send_one():
     bus = can.interface.Bus(bustype='pcan', channel='PCAN_USBBUS1', bitrate=250000)
+
+    # Other buses work similar:
+    #bus = can.interface.Bus(bustype='socketcan', channel='vcan0', bitrate=250000)
     #bus = can.interface.Bus(bustype='ixxat', channel=0, bitrate=250000)
     #bus = can.interface.Bus(bustype='vector', app_name='CANalyzer', channel=0, bitrate=250000)
 
     msg = can.Message(arbitration_id=0xc0ffee,
                       data=[0, 25, 0, 1, 3, 1, 4, 1],
                       extended_id=True)
+
     try:
         bus.send(msg)
         print("Message sent on {}".format(bus.channel_info))
     except can.CanError:
         print("Message NOT sent")
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     send_one()
diff --git a/examples/serial_com.py b/examples/serial_com.py
@@ -1,4 +1,6 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 This example sends every second a messages over the serial interface and also 
 receives incoming messages.
@@ -17,10 +19,13 @@
         com0com: http://com0com.sourceforge.net/
 """
 
+from __future__ import print_function
+
 import time
-import can
 import threading
 
+import can
+
 
 def send_cyclic(bus, msg, stop_event):
     print("Start to send a message every 1s")
diff --git a/examples/simpleLogConvert.py b/examples/simpleLogConvert.py
@@ -1,8 +1,14 @@
 #!/usr/bin/env python
-# use it to convert .can-log files
-# usage: simpleLogConvert.py sourceLog.asc targetLog.log
+# coding: utf-8
+
+"""
+Use this to convert .can log files. 
+
+Usage: simpleLogConvert.py sourceLog.asc targetLog.log
+"""
 
 import sys
+
 import can.io.logger
 import can.io.player
 
diff --git a/examples/vcan_filtered.py b/examples/vcan_filtered.py
@@ -1,14 +1,24 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+This shows how message filtering works.
+"""
+
 import time
+
 import can
 
-bus = can.interface.Bus(bustype='socketcan',
-                        channel='vcan0',
-                        receive_own_messages=True)
-
-can_filters = [{"can_id": 1, "can_mask": 0xf, "extended": True}]
-bus.set_filters(can_filters)
-notifier = can.Notifier(bus, [can.Printer()])
-bus.send(can.Message(arbitration_id=1, extended_id=True))
-bus.send(can.Message(arbitration_id=2, extended_id=True))
-bus.send(can.Message(arbitration_id=1, extended_id=False))
-time.sleep(10)
+if __name__ == '__main__':
+    bus = can.interface.Bus(bustype='socketcan',
+                            channel='vcan0',
+                            receive_own_messages=True)
+
+    can_filters = [{"can_id": 1, "can_mask": 0xf, "extended": True}]
+    bus.set_filters(can_filters)
+    notifier = can.Notifier(bus, [can.Printer()])
+    bus.send(can.Message(arbitration_id=1, extended_id=True))
+    bus.send(can.Message(arbitration_id=2, extended_id=True))
+    bus.send(can.Message(arbitration_id=1, extended_id=False))
+
+    time.sleep(10)
diff --git a/examples/virtual_can_demo.py b/examples/virtual_can_demo.py
@@ -1,3 +1,6 @@
+#!/usr/bin/env python
+# coding: utf-8
+
 """
 This demo creates multiple processes of Producers to spam a socketcan bus.
 """
@@ -16,6 +19,7 @@ def producer(id):
     for i in range(16):
         msg = can.Message(arbitration_id=0x0cf02200+id, data=[id, i, 0, 1, 3, 1, 4, 1])
         bus.send(msg)
+
     # TODO Issue #3: Need to keep running to ensure the writing threads stay alive. ?
     time.sleep(2)
 
