Skip to content

Commit

Permalink
add udev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
CrazyIvan359 committed Oct 11, 2020
1 parent 4cb9a98 commit 9fdcd91
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
21 changes: 21 additions & 0 deletions source/interface/gpio/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,27 @@ See below for a list of supported boards that this module can be used with.
**You will also need to install requirements for the board you are using.**


Permissions
===========

A ``udev`` rule file is provided to simplify access permissions for GPIO pins.

First add the ``gpio`` group if it does not exist:

.. code-block:: shell
sudo addgroup --system gpio
Then install the ``udev`` rule, add the user running MQTTany to the ``gpio``
group, and reboot:

.. code-block:: shell
sudo cp udev/98-gpio.rules /etc/udev/rules.d/
sudo usermod -aG gpio mqttany
sudo reboot now
Supported Boards
================

Expand Down
21 changes: 21 additions & 0 deletions source/interface/i2c/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,27 @@ driver.
system you are using.


Permissions
===========

A ``udev`` rule file is provided to simplify access permissions for I2C buses.

First add the ``i2c`` group if it does not exist:

.. code-block:: shell
sudo addgroup --system i2c
Then install the ``udev`` rule, add the user running MQTTany to the ``i2c``
group, and reboot:

.. code-block:: shell
sudo cp udev/98-i2c.rules /etc/udev/rules.d/
sudo usermod -aG i2c mqttany
sudo reboot now
Devices
=======

Expand Down
21 changes: 21 additions & 0 deletions source/interface/onewire/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,27 @@ The OneWire module provides access to Dallas/Maxim OneWire devices using the
This process will vary based on the board and operatering system you are using.


Permissions
===========

A ``udev`` rule file is provided to simplify access permissions for ``wire-1`` devices.

First add the ``wire`` group if it does not exist:

.. code-block:: shell
sudo addgroup --system wire
Then install the ``udev`` rule, add the user running MQTTany to the ``wire``
group, and reboot:

.. code-block:: shell
sudo cp udev/98-w1.rules /etc/udev/rules.d/
sudo usermod -aG wire mqttany
sudo reboot now
Devices
=======

Expand Down

0 comments on commit 9fdcd91

Please sign in to comment.