Skip to content

Commit

Permalink
Improvements to page navigation and minor clarifications on writing a…
Browse files Browse the repository at this point in the history
… plugin
  • Loading branch information
David Albrecht committed Jan 10, 2024
1 parent a007049 commit 7396d77
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion _docs/general/acquire-the-hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Plug type: 2.1 x 5.5mm, center positive

## Summary

Once you have your Pi and microSD card, you can move onto [the software](./install-the-software).
Once you have your Pi and microSD card, you can move onto [the software](./install-the-software.html).
2 changes: 1 addition & 1 deletion _docs/general/create-your-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ The final part of the plan is the location to install the power monitor. The se

### Summary

Now that you have your plan, you're ready to [purchase the hardware](./acquire-the-hardware).
Now that you have your plan, you're ready to [purchase the hardware](./acquire-the-hardware.html).

If this page did not answer your questions for planning, please see [the FAQ]({{site.baseurl}}/FAQ).
6 changes: 4 additions & 2 deletions _docs/v0.3.0/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ There are countless possibilities for plugin functionality. Here are some exampl

## Writing a Plugin

{: .note-cream }
See the <a href="https://github.com/David00/rpi-power-monitor/blob/develop/v0.3.0-plugins/rpi_power_monitor/plugins/gpio_controller_example_plugin/gpio_controller_example_plugin.py">GPIO Controller plugin</a> for a real example of all of the concepts and guidelines in this section.

### Git checkout the plugin development branch
At the time of writing, plugins are currently not supported on `master`. Checkout the `develop/v0.3.0-plugins` branch to test and develop plugins.
Expand Down Expand Up @@ -83,8 +85,8 @@ Done! Created sample_plugin_2.py and README.md inside plugins/sample_plugin_2/
All plugins must adhere to the following structure and naming conventions:

* The plugin must reside in a folder inside of `rpi_power_monitor/plugins`, and the folder name must match the name of the file containing the code for your plugin.
* Created a barebones Python file with the <a href="#required-functions">required functions</a>
* A README.md in your plugin's folder (see #readme)
* The plugin must include the <a href="#required-functions">required functions</a>
* The plugin folder must contain A README.md (see <a href="#readme">README</a>) that follows the laid out structure.

The [convenience script](#create-your-plugin-files-and-folder) mentioned above will initialize a new plugin that follows the guidelines above.

Expand Down

0 comments on commit 7396d77

Please sign in to comment.