Expander Pi - Reading IO Inputs
Created 16/06/2017 | Reading the IO inputs on the Expander Pi
In this tutorial we will read from the inputs on the IO device on your Expander Pi and display the inputs status on the console. For this you will need your Raspberry Pi, an Expander Pi and up to 16 single pole switches and connecting wire.
We will use the AB Electronics python library to talk to the Expander Pi, to download the library visit our Python Library and Demos knowledge base article.
You will need to enable i2c on your Raspberry Pi, see our other tutorial on i2c: I2C, SMBus and Raspbian Linux
The AB Electronics python library uses another library called python-smbus, you can install it using apt-get with the following commands.
sudo apt-get update
sudo apt-get install python-smbus
With the libraries installed and the Raspberry Pi configured to use i2c we can begin building our project.
If you haven’t done so install your Expander Pi onto the Raspberry Pi by connecting it onto the GPIO header. Make sure your Raspberry Pi is turned off when you do this to minimise the risk of damaging the Raspberry Pi or the Expander Pi.
Next connect your input switches to the IO ports and connect the output of each switch to ground.
The Expander Pi contains an MCP23017 I/O controller chip from Microchip. The MCP23017 is an i2c based controller containing 16 I/O pins which can be configured individually as inputs or outputs.
For this tutorial we will start by creating a new python program file called demo-ioread.py. You can use your favourite text editor for writing the program. You can find a complete example of demo_ioread.py in the ABElectronics_Python_Libraries/ABElectronics_ExpanderPi/demos folder.
At the top of your program you will need to import the IO class from the ExpanderPi library and time library.
from ExpanderPi import IO
The Expander Pi library is used for all communication with your Expander Pi, it gives you control over almost everything that can be done with the MCP23017 controller.
We will create an instance of the IO class and call it io.
io = IO()
With our new instance of the IO class we will be able to access all of the available methods for controlling the Expander Pi. Let’s begin by setting the pins to be inputs on pins 1 to 8.
The 16 channels on the I/O bus is split into two 8 pin ports. Port 0 controls pins 1 to 8 while port 1 controls pins 9 to 16. Having two 8 pin ports gives us the ability to change the direction on 8 pins at once by sending an 8 bit byte of information to the Expander Pi. You can also set each pin separately using the set_pin_direction command but for our tutorial today we will stick with using set_port_direction.
set_port_direction takes two variables, the first is the port you want to control, 0 for pins 1 to 8 and 1 for pins 9 to 16. The second variable is the command byte for setting the individual pin directions. Setting a pin to 0 makes it an output while setting it to 1 makes it an input, just remember 0 = out, 1 = in.
As a byte in binary is 8 bits long each bit represents one of the pins on the selected port. The least significant bit or the one nearest the right represents the lowest pin number while the most significant bit or the one nearest the left represents the highest pin number. If we wanted to set pins 1 to 4 as inputs and 5 to 8 as outputs we could send the binary number 00001111. If we wanted just pin 7 to be an input and everything else to be an output we could send the binary number 01000000.
When working in python or most other languages it it’s the normal convention when dealing with bytes to use hexadecimal rather than binary numbers so 00001111 would become 0x0F while 01000000 becomes 0x40. If you are not very good at converting between binary and hexadecimal in your head there are plenty of online converters available.
As we want all of the pins to be outputs we will send the binary number 11111111 which converted to hexadecimal is 0xFF.
Next we need to set the internal pullup resistors to be enabled. The pullup resistors connect the input to the 5V supply using 100K resistors inside the IO chip. This will keep the inputs in a high state so when nothing is connected to the input it will read 1. Connecting your switches between the inputs and ground will short the resistors to ground pulling the input low. This means that turning the switch on will show a 0 on the input while turning it off will show a 1.
As with set_port_direction, set_port_pullups takes two variables, the first is the port to write to 0 or 1 and the second is the 8 bit value as detailed above.
We then need to repeat this for the second bus for pins 9 to 16.
The Expander Pi is now set up to read the inputs.
The first thing we are going to need is a loop so that the same commands can run over and over. This can be done with a simple while loop.
As True is always true the while loop will keep running until you exit the program with a Ctrl-C.
We then need to clear the console.
Now we read each of the IO input pins and write its status to the console.
print 'Pin 1: ' + str(io.read_pin(1))
print 'Pin 2: ' + str(io.read_pin(2))
print 'Pin 3: ' + str(io.read_pin(3))
print 'Pin 4: ' + str(io.read_pin(4))
print 'Pin 5: ' + str(io.read_pin(5))
print 'Pin 6: ' + str(io.read_pin(6))
print 'Pin 7: ' + str(io.read_pin(7))
print 'Pin 8: ' + str(io.read_pin(8))
print 'Pin 9: ' + str(io.read_pin(9))
print 'Pin 10: ' + str(io.read_pin(10))
print 'Pin 11: ' + str(io.read_pin(11))
print 'Pin 12: ' + str(io.read_pin(12))
print 'Pin 13: ' + str(io.read_pin(13))
print 'Pin 14: ' + str(io.read_pin(14))
print 'Pin 15: ' + str(io.read_pin(15))
print 'Pin 16: ' + str(io.read_pin(16))
time.sleep takes one variable, a number which represents the number of seconds to wait. 0.1 would wait for 100ms. This adds a short delay before reading the inputs again.
That is everything we need to read the IO inputs.
from ExpanderPi import IO
# We will read the inputs 1 to 16 from the I/O bus so set port 0 and port 1 to be
# inputs and enable the internal pull-up resistors
# clear the console
# read the pins 1 to 16 and print the results
print('Pin 1: ' + str(io.read_pin(1)))
print('Pin 2: ' + str(io.read_pin(2)))
print('Pin 3: ' + str(io.read_pin(3)))
print('Pin 4: ' + str(io.read_pin(4)))
print('Pin 5: ' + str(io.read_pin(5)))
print('Pin 6: ' + str(io.read_pin(6)))
print('Pin 7: ' + str(io.read_pin(7)))
print('Pin 8: ' + str(io.read_pin(8)))
print('Pin 9: ' + str(io.read_pin(9)))
print('Pin 10: ' + str(io.read_pin(10)))
print('Pin 11: ' + str(io.read_pin(11)))
print('Pin 12: ' + str(io.read_pin(12)))
print('Pin 13: ' + str(io.read_pin(13)))
print('Pin 14: ' + str(io.read_pin(14)))
print('Pin 15: ' + str(io.read_pin(15)))
print('Pin 16: ' + str(io.read_pin(16)))
# wait 0.5 seconds before reading the pins again
Save your program and run it in a command terminal using
You will be shown a list in the console window of the 16 inputs and its current state with 1 being high or on and 0 being low or off.