diff --git a/README.md b/README.md index daa0d78..6330a6e 100644 --- a/README.md +++ b/README.md @@ -90,9 +90,9 @@ Please run `check_otp -h` for an actual overview of the available options. The script currently supports 3 modes of operation: * password - simply authenticate with the provided secret (no calculations) - * totp - calculate the TOTP code using a key and current time - * hotp - calculate the HOTP code using a key and a count (automatically - increments the count in case a count file is used) + * totp - calculate the TOTP code using a key and current time + * hotp - calculate the HOTP code using a key and a count (automatically + increments the count in case a count file is used) Generic parameters (connection parameters, critical/warning thresholds, etc.) should be provided before the mode of operation is specified, mode-specific @@ -253,23 +253,31 @@ provide a patch). For information on how to connect sensor to the RaspberryPi and to get it working please click on the links in the list above. As per these, most sensors require some configuration to make them available: * No setup is required to read the CPU temperature. + * To enable 1-wire interface support on the RaspberryPi use the command: + ~~~ sudo raspi-config nonint do_onewire 0 ~~~ + or use `raspi-config` interactively (1. Interfacing Options --> P7. 1-Wire). Please note that changing this requires a reboot. + * To enable I2C interface support on the RaspberryPi use the command: + ~~~ sudo raspi-config nonint do_i2c 0 ~~~ + or use `raspi-config` interactively (1. Interfacing Options --> P5. I2C). Please note that changing this requires a reboot. The I2C interface also requires the `SMBus` or `SMBus2` library, to install the `SMBus` library on Raspbian Linux run: + ~~~ sudo apt install python-smbus ~~~ + `SMBus2` is a pure Python implementation that requires system-wide or a `virtualenv`-based installation, less trivial than installing the package.