Update README.rst and example
This commit is contained in:
		
							
								
								
									
										38
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										38
									
								
								README.rst
									
									
									
									
									
								
							| @@ -10,47 +10,13 @@ Introduction | |||||||
|     :target: https://discord.gg/nBQh6qu |     :target: https://discord.gg/nBQh6qu | ||||||
|     :alt: Discord |     :alt: Discord | ||||||
|  |  | ||||||
| .. image:: https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/workflows/Build%20CI/badge.svg | Micropython port of the CircuitPython module for the MAX31865 thermocouple amplifier. | ||||||
|     :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX31865/actions/ |  | ||||||
|     :alt: Build Status |  | ||||||
|  |  | ||||||
| CircuitPython module for the MAX31865 thermocouple amplifier. |  | ||||||
|  |  | ||||||
| Dependencies | Dependencies | ||||||
| ============= | ============= | ||||||
| This driver depends on: | This driver depends on: | ||||||
|  |  | ||||||
| * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_ | * `MicroPython <https://github.com/micropython/micropython>`_ | ||||||
| * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_ |  | ||||||
|  |  | ||||||
| Please ensure all dependencies are available on the CircuitPython filesystem. |  | ||||||
| This is easily achieved by downloading |  | ||||||
| `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_. |  | ||||||
|  |  | ||||||
| Installing from PyPI |  | ||||||
| ===================== |  | ||||||
| On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from |  | ||||||
| PyPI <https://pypi.org/project/adafruit-circuitpython-max31865/>`_. To install for current user: |  | ||||||
|  |  | ||||||
| .. code-block:: shell |  | ||||||
|  |  | ||||||
|     pip3 install adafruit-circuitpython-max31865 |  | ||||||
|  |  | ||||||
| To install system-wide (this may be required in some cases): |  | ||||||
|  |  | ||||||
| .. code-block:: shell |  | ||||||
|  |  | ||||||
|     sudo pip3 install adafruit-circuitpython-max31865 |  | ||||||
|  |  | ||||||
| To install in a virtual environment in your current project: |  | ||||||
|  |  | ||||||
| .. code-block:: shell |  | ||||||
|  |  | ||||||
|     mkdir project-name && cd project-name |  | ||||||
|     python3 -m venv .env |  | ||||||
|     source .env/bin/activate |  | ||||||
|     pip3 install adafruit-circuitpython-max31865 |  | ||||||
|  |  | ||||||
|  |  | ||||||
| Usage Example | Usage Example | ||||||
| ============= | ============= | ||||||
|   | |||||||
| @@ -2,17 +2,20 @@ | |||||||
| # Will print the temperature every second. | # Will print the temperature every second. | ||||||
| import time | import time | ||||||
|  |  | ||||||
| import board | import machine | ||||||
| import busio |  | ||||||
| import digitalio |  | ||||||
|  |  | ||||||
| import adafruit_max31865 | import adafruit_max31865 | ||||||
|  |  | ||||||
|  |  | ||||||
| # Initialize SPI bus and sensor. | # Initialize SPI bus and sensor. | ||||||
| spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO) | spi=machine.SPI( | ||||||
| cs = digitalio.DigitalInOut(board.D5)  # Chip select of the MAX31865 board. |                 -1, | ||||||
| sensor = adafruit_max31865.MAX31865(spi, cs) |                 sck=machine.Pin(14, machine.Pin.OUT), | ||||||
|  |                 mosi=machine.Pin(13, machine.Pin.OUT), | ||||||
|  |                 miso=machine.Pin(12, machine.Pin.OUT) | ||||||
|  |                 ) | ||||||
|  | spi.init(baudrate=115200, polarity=0, phase=1) | ||||||
|  | cs=machine.Pin(2) | ||||||
|  | sensor=adafruit_max31865.MAX31865(spi, cs) | ||||||
| # Note you can optionally provide the thermocouple RTD nominal, the reference | # Note you can optionally provide the thermocouple RTD nominal, the reference | ||||||
| # resistance, and the number of wires for the sensor (2 the default, 3, or 4) | # resistance, and the number of wires for the sensor (2 the default, 3, or 4) | ||||||
| # with keyword args: | # with keyword args: | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user