Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −0
Open

Update README.md #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -41,6 +41,20 @@ NOTE: A plugin needs to be supported by the processor specific driver - as a min
* ['Datron like' RGB indicator lights](https://github.com/5ocworkshop/grblhal-rgb-plugin) - by 5ocworkshop.
* [Add status of digital aux outputs to real-time report](https://github.com/Avatario34/auxp) - by Avatario34.

### How to enable plugins
Let's look at an example of how to add and enable a plugin.
1. first of all need add plugin via git submodule ```git submodule add https://github.com/grblHAL/Plugin_keypad keypad```
2. add code to ```Src/driver.c```
```
#if KEYPAD_ENABLE
#include "keypad/keypad.h"
#endif
```
3. define in _Inc/my_machine.h_ UART keypad ```#define KEYPAD_ENABLE 2```
4. add _keypad_ folder to source folder: Project->Properties->C/C++ General->Path and Symbols->Source Location
![svg](https://user-images.githubusercontent.com/20260062/239670801-a7c1bbb0-3383-4637-96d4-3865bab2a628.png)


### Example and template plugins

A number of example and template plugins can be found [here](https://github.com/grblHAL/Templates/tree/master/my_plugin). Some are usable 'as-is', some not.