Fixed example on README

Author: ecodina

README.md

@@ -8,9 +8,9 @@ This Python module let's you control the AS3935 lightning detector. The board us
  3. It allows you to perform every action described in the [datasheet](http://www.embeddedadventures.com/datasheets/AS3935_Datasheet_EN_v2.pdf).
 
 To install it from Pypi:
- ```
+```
 $ pip install as3935
- ```
+```
 
 
 # 1. Connection of the device
@@ -60,14 +60,14 @@ This module has been tested on Python 3.7. It might work on other versions as we
 It is very simple to use. Just import it and create a new object with the configuration you need.
 
 ```
-from as3935 import AS3935
+import as3935
 import pigpio
     
 irq_pin_number = 4    # BCM number (code after GPIO)
 bus = 1               # On newer Raspberrys is 1
 address = 0x03        # If using MOD-1016 this is the address
 
-sensor = AS3935.AS3935(irq_pin_number, bus, address)
+sensor = as3935.AS3935(irq_pin_number, bus, address)
 
 # We need to calibrate the sensor first. Use the tuning cap provided
 # or calculate it using sensor.calculate_tuning_cap(*args)
@@ -78,22 +78,22 @@ sensor.set_indoors(True)
 # Every time you sense a pulse on IRQ it means there is an
 # interruption request. You can read it like this:
 def irq_callback(gpio, level, tick):
-	interruption = sensor.get_interrupt()
-	if interruption == AS3935.INT_NH:
-		print("Noise floor too high")
-	elif interruption == AS3935.INT_D:
-		print("Disturbance detected. Mask it?")
-	elif interruption == AS3935.INT_L:
-		print("Lightning detected!")
-		distance = sensor.get_distance()
+    interruption = sensor.get_interrupt()
+    if interruption == as3935.INT_NH:
+        print("Noise floor too high")
+    elif interruption == as3935.INT_D:
+        print("Disturbance detected. Mask it?")
+    elif interruption == as3935.INT_L:
+        print("Lightning detected!")
+        distance = sensor.get_distance()
 
 try:
-	cb = sensor.pi.callback(irq_pin_number, pigpio.RISING_EDGE, irq_callback)
-	while True:
-		pass
+    cb = sensor.pi.callback(irq_pin_number, pigpio.RISING_EDGE, irq_callback)
+    while True:
+        pass
 finally:
-	cb.cancel()
-	sensor.pi.stop()   
+    cb.cancel()
+    sensor.pi.stop()
 ```  
 
 This above is a very simple example. Check the full documentation to learn all the methods you can call.

README.rst

@@ -12,7 +12,11 @@ board used is the MOD-1016 from
 3. It allows you to perform every action described in the
    `datasheet <http://www.embeddedadventures.com/datasheets/AS3935_Datasheet_EN_v2.pdf>`__.
 
-To install it from Pypi: ``$ pip instal as3935``
+To install it from Pypi:
+
+::
+
+   $ pip install as3935
 
 1. Connection of the device
 ===========================
@@ -83,14 +87,14 @@ the configuration you need.
 
 ::
 
-   from as3935 import AS3935
+   import as3935
    import pigpio
        
    irq_pin_number = 4    # BCM number (code after GPIO)
    bus = 1               # On newer Raspberrys is 1
    address = 0x03        # If using MOD-1016 this is the address
 
-   sensor = AS3935.AS3935(irq_pin_number, bus, address)
+   sensor = as3935.AS3935(irq_pin_number, bus, address)
 
    # We need to calibrate the sensor first. Use the tuning cap provided
    # or calculate it using sensor.calculate_tuning_cap(*args)
@@ -102,11 +106,11 @@ the configuration you need.
    # interruption request. You can read it like this:
    def irq_callback(gpio, level, tick):
        interruption = sensor.get_interrupt()
-       if interruption == AS3935.INT_NH:
+       if interruption == as3935.INT_NH:
            print("Noise floor too high")
-       elif interruption == AS3935.INT_D:
+       elif interruption == as3935.INT_D:
            print("Disturbance detected. Mask it?")
-       elif interruption == AS3935.INT_L:
+       elif interruption == as3935.INT_L:
            print("Lightning detected!")
            distance = sensor.get_distance()
 
@@ -116,7 +120,7 @@ the configuration you need.
            pass
    finally:
        cb.cancel()
-       sensor.pi.stop()   
+       sensor.pi.stop()
 
 This above is a very simple example. Check the full documentation to
 learn all the methods you can call.

as3935/__init__.py

@@ -1 +1 @@
-from as3953.AS3935 import AS3935, INT_L, INT_D, INT_NH
+from as3935.AS3935 import AS3935, INT_L, INT_D, INT_NH

example.py

@@ -0,0 +1,36 @@
+import as3935
+import pigpio
+
+irq_pin_number = 4  # BCM number (code after GPIO)
+bus = 1  # On newer Raspberrys is 1
+address = 0x03  # If using MOD-1016 this is the address
+
+sensor = as3935.AS3935(irq_pin_number, bus, address)
+
+# We need to calibrate the sensor first. Use the tuning cap provided
+# or calculate it using sensor.calculate_tuning_cap(*args)
+sensor.full_calibration(12)
+
+sensor.set_indoors(True)
+
+
+# Every time you sense a pulse on IRQ it means there is an
+# interruption request. You can read it like this:
+def irq_callback(gpio, level, tick):
+    interruption = sensor.get_interrupt()
+    if interruption == as3935.INT_NH:
+        print("Noise floor too high")
+    elif interruption == as3935.INT_D:
+        print("Disturbance detected. Mask it?")
+    elif interruption == as3935.INT_L:
+        print("Lightning detected!")
+        distance = sensor.get_distance()
+
+
+try:
+    cb = sensor.pi.callback(irq_pin_number, pigpio.RISING_EDGE, irq_callback)
+    while True:
+        pass
+finally:
+    cb.cancel()
+    sensor.pi.stop()

setup.py

@@ -8,15 +8,15 @@
 setup(
   name='as3935',
   packages=['as3935'],
-  version='0.1.1',
+  version='0.1.3',
   license='gpl-3.0',
   description="A Python3 module to control the lightning detector AS3935 chip",
   long_description=long_description,
   long_description_content_type="text/x-rst",
   author = 'Eloi Codina',
   author_email = 'eloi.codina@gmail.com',
   url = 'https://github.com/ecodina/python_as3935',
-  download_url='https://github.com/ecodina/python_as3935/archive/v0.1.1-beta.tar.gz',
+  download_url='https://github.com/ecodina/python_as3935/archive/v0.1.3-beta.tar.gz',
   keywords = ['python', 'raspberry', 'gpio', 'lightning', 'sensor'],
   install_requires=[
           'pigpio',