Formatting changes on README.md v4

develop
jhealy 4 years ago
parent b96dde47ef
commit 7733a922b6

@ -31,8 +31,8 @@ tickerPi is a Python Program to handle WS281X LED interactions on a Raspberry P
``` ```
* If this fails, try this and repeat step 1 * If this fails, try this and repeat step 1
``` ```
sudo apt-get install python3-pip sudo apt-get install python3-pip
``` ```
* Recommended, but may not be required, setting your Python install to default with Python 3. There are multiple ways to do this, here's an example: * Recommended, but may not be required, setting your Python install to default with Python 3. There are multiple ways to do this, here's an example:
``` ```
sudo apt-get install -y python3 git python3-pip sudo apt-get install -y python3 git python3-pip
@ -42,76 +42,76 @@ tickerPi is a Python Program to handle WS281X LED interactions on a Raspberry P
``` ```
2. Enabling I2C and SPI, which is only required to be done **once** for **each** Raspberry Pi:\ 2. Enabling I2C and SPI, which is only required to be done **once** for **each** Raspberry Pi:\
**Only Required if you are using multiple devices on your Raspberry Pi, if not, move to step 3**\ **Only Required if you are using multiple devices on your Raspberry Pi, if not, move to step 3**\
**Important:** **Important:**
> If you are using a GPIO wiring setup for the LEDs that does not support I2C, you will not see anything show up for the LEDS.\ > If you are using a GPIO wiring setup for the LEDs that does not support I2C, you will not see anything show up for the LEDS.\
Again, this is only for if you have **OTHER** devices you plan on hooking up to make sure they still show up under I2C\ > Again, this is only for if you have **OTHER** devices you plan on hooking up to make sure they still show up under I2C\
* Enabling I2C: * Enabling I2C:
* From Command Line: * From Command Line:
``` ```
sudo apt-get install -y python-smbus sudo apt-get install -y python-smbus
sudo apt-get install -y i2c-tools sudo apt-get install -y i2c-tools
sudo raspi-config sudo raspi-config
``` ```
* Interfacing Options > I2C > Enable > Yes * Interfacing Options > I2C > Enable > Yes
> If you did not hit "finish" you can repeat these steps but change out the I2C for the SPI > If you did not hit "finish" you can repeat these steps but change out the I2C for the SPI
* Enabling SPI: * Enabling SPI:
* From Command Line: * From Command Line:
``` ```
sudo raspi-config sudo raspi-config
``` ```
* Interfacing Options > SPI > Enable > Yes * Interfacing Options > SPI > Enable > Yes
* Click "Finish" * Click "Finish"
* Reboot your Raspberry Pi * Reboot your Raspberry Pi
``` ```
sudo reboot sudo reboot
``` ```
* Testing I2C and SPI after reboot: * Testing I2C and SPI after reboot:
* I2C Testing: * I2C Testing:
``` ```
sudo i2cdetect -y 1 sudo i2cdetect -y 1
```
* If you do not get anything back from the above command, try seeing which I2C is being used under Dev:
```
ls /dev/i2c*
```
> whichever number is after the "-" in "/dev/i2c-(X) is what you should replace the number in the command with
>> Example: /dev/i2c-3 = "sudo i2cdetect -y 3"
* SPI Testing:
```
ls -l /dev/spidev*
```
> This should return a device for each SPI bus (two)
3. Installing Python Support Libraries:
* GPIO - If not already installed:
```
sudo pip3 install RPI.GPIO
``` ```
* Adafruit Blinka: * If you do not get anything back from the above command, try seeing which I2C is being used under Dev:
``` ```
sudo pip3 install adafruit-blinka ls /dev/i2c*
``` ```
* RPi WS281X and Neopixel: > whichever number is after the "-" in "/dev/i2c-(X) is what you should replace the number in the command with
``` >> Example: /dev/i2c-3 = "sudo i2cdetect -y 3"
sudo pip3 install rpi_ws281x adafruit-circuitpython-neopixel * SPI Testing:
sudo python3 -m pip install --force-reinstall adafruit-blinka
```
* PixelFramebuffer:
``` ```
sudo pip3 install adafruit-circuitpython-pixel-framebuf ls -l /dev/spidev*
``` ```
4. Changing Conflicting HDMI Settings:\ > This should return a device for each SPI bus (two)
**Important:** Only do this if you are having issues with the LEDs, this is not always needed!\ 3. Installing Python Support Libraries:
* GPIO - If not already installed:
```
sudo pip3 install RPI.GPIO
``` ```
sudo nano /boot/config.txt * Adafruit Blinka:
``` ```
* If it doesn't already exist, add: sudo pip3 install adafruit-blinka
``` ```
hdmi_force_hotplug=1 * RPi WS281X and Neopixel:
hdmi_force_edid_audio=1 ```
``` sudo pip3 install rpi_ws281x adafruit-circuitpython-neopixel
* Save and exit the file (ctrl + x > y) sudo python3 -m pip install --force-reinstall adafruit-blinka
* Reboot Raspberry Pi ```
``` * PixelFramebuffer:
```
sudo pip3 install adafruit-circuitpython-pixel-framebuf
```
4. Changing Conflicting HDMI Settings:\
**Important:** Only do this if you are having issues with the LEDs, this is not always needed!\
```
sudo nano /boot/config.txt
```
* If it doesn't already exist, add:
```
hdmi_force_hotplug=1
hdmi_force_edid_audio=1
```
* Save and exit the file (ctrl + x > y)
* Reboot Raspberry Pi
```
sudo reboot sudo reboot
``` ```
## Usage ## Usage

Loading…
Cancel
Save