Skip to content

Commit 13544f0

Browse files
authored
Add some README sections.
1 parent 962ea43 commit 13544f0

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,3 +177,24 @@ Settings
177177
Currently the Raspberry Pi agent has settings for enabling/disabling the device tree, SPI, I²C, serial and camera. These are set via the ``myDevices.os.raspiconfig`` module which runs a separate Bash script at ``/etc/myDevices/scripts/config.sh``. If any of these settings are available on your board and you would like to support them you can override or replace ``myDevices.os.raspiconfig.py``. Otherwise the settings functionality can be ignored.
178178

179179
*Note:* For security reasons the Cayenne agent is designed to be able to run from an account without root privileges. If any of your I/O, system info or settings code requires root access consider running it via a separate process that can be launched using sudo. For example, the ``myDevices.os.raspiconfig`` module uses this method to update config settings.
180+
181+
************
182+
Contributing
183+
************
184+
The Cayenne agent is an open source project and welcomes your contributions, including:
185+
186+
* Bug reports and fixes
187+
* Documentation improvements
188+
* Additional sensor/actuator support
189+
* Additional board support
190+
* Other code enhancements
191+
192+
*****************
193+
Cayenne Community
194+
*****************
195+
Join us on Slack at `mydevices-cayenne.slack.com <https://mydevices-cayenne.slack.com>`_ or in the `Cayenne Community <http://community.mydevices.com>`_.
196+
197+
*******
198+
License
199+
*******
200+
`MIT <LICENSE>`_

0 commit comments

Comments
 (0)