maocypher / Octoprint-Smart-Filament-Sensor

OctoPrint plugin that lets integrate Smart Filament Sensors like BigTreeTechs SmartFilamentSensor directly to RaspberryPi GPIO pins.
GNU General Public License v3.0
13 stars 20 forks source link

GPIO pin numbering note in Readme? #25

Closed zapdogster closed 3 years ago

zapdogster commented 3 years ago

A suggested ReadMe addition for those not being familiar with RPi GPIO. I did not know the difference between BCM and BOARD mode numbering. I would have found something like the following in the GPIO section to a be good heads up for a newbie:

• Be aware of the difference between BCM and BOARD for the “Board Pin Mode” mode dropdown selection: o BOARD mode numbering refers to the physical pin number of the GPIO connector o BCM mode numbering refers to the pin function, by the "Broadcom SOC channel" numbering - i.e. the numbers after the “GPIO” label o Example on a RPi 3B: BOARD mode pin 23 == BCM mode pin 11 (i.e. GPIO11)

Thanks for the great plugin!

maocypher commented 3 years ago

Thanks for the suggestion. I will extend the description soon :)

maocypher commented 3 years ago

Extended description for the next release https://github.com/maocypher/Octoprint-Smart-Filament-Sensor/tree/PreRelease