From 599fdab7c7f570178db6091c9ab040d99a6719cb Mon Sep 17 00:00:00 2001
From: Foxtrot <foxtrotnull@gmail.com>
Date: Tue, 12 Jul 2016 13:33:57 +0100
Subject: [PATCH 1/5] Create Module.php section

---
 api.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/api.md b/api.md
index 104db93..6f500e8 100644
--- a/api.md
+++ b/api.md
@@ -227,7 +227,7 @@ Action|Description|Parameters
 `removeSSID`|Removes an SSID from the pool|<ul><li>`ssid`<ul><li>The SSID string to remove</li></ul></li>
 `setPineAPSettings`|Update PineAP's settings|<ul> <li>`settings` <ul> <li>A dictionary with setting key/value pairs <ul> <li>`allowAssociations` <ul> <li>Whether clients should be allowed to associate to the pineapple</li> </ul> </li> <li>`logProbes` <ul> <li>Whether to log probe requests</li> </ul> </li> <li>`logAssociations` <ul> <li>Whether to log associations</li> </ul> </li> <li>`beaconResponses` <ul> <li>Whether to send beacon responses</li> </ul> </li> <li>`captureSSIDs` <ul> <li>Whether to add sniffed SSIDs to the pool</li> </ul> </li> <li>`broadcastSSIDs` <ul> <li>Whether to broadcast the SSID pool</li> </ul> </li> <li>`beaconInterval` <ul> <li>The beacon interval- must be one of "low", "normal" or "aggressive"</li> </ul> </li> <li>`responseInterval` <ul> <li>The response interval- must be one of "low", "normal" or "aggressive"</li> </ul> </li> <li>`targetMAC` <ul> <li>The MAC to target with responses</li> </ul> </li> <li>`sourceMAC` <ul> <li>The MAC PineAP should spoof</li> </ul> </li> </ul> </li> </ul> </li></ul>
 `getPineAPSettings`|Returns a dictionary with all the current PineAP settings|_none_
-`deauth`|Deauth a list of clients from a station. **_Use this with caution. The misuse of this function may be illegal in some places._**|<ul><li>`sta`<ul><li>The bssid of the station from which to disconnect the clients</li></ul></li><li>`clients`<ul><li>An array of client MACs to deauth</li></ul></li><li>`multiplier`<ul><li>The number of deauths (from 1 to 10) to send</li></ul></li><li>`channel`<ul><li>The channel to hop to before sending the frame(s)</li></ul></ul></li></ul>
+`deauth`|Deauth a list of clients from a station. **_Use this with caution. The misuse of this function may be illegal in some places._***|<ul><li>`sta`<ul><li>The bssid of the station from which to disconnect the clients</li></ul></li><li>`clients`<ul><li>An array of client MACs to deauth</li></ul></li><li>`multiplier`<ul><li>The number of deauths (from 1 to 10) to send</li></ul></li><li>`channel`<ul><li>The channel to hop to before sending the frame(s)</li></ul></ul></li></ul>
 `enable`|Enables PineAP|_none_
 `disable`|Disables PineAP|_none_
 `saveAsDefault`|Makes the current configuration persist after reboots|_none_
@@ -282,6 +282,13 @@ Action|Description|Parameters
 `addMac`|Adds a MAC to tracking|<ul><li>`mac`<ul><li>The MAC address to start tracking</li></ul></li>
 `removeMac`|Removes a MAC from tracking|<ul><li>`mac`<ul><li>The MAC address to stop tracking</li></ul></li>
 
+## Module.php API
+Every module must extend the `Module` class that resides in `Module.php`. Extending this class gives the module access to the following API functions.
+
+Test|Test|Test
+----|----|----
+deez|nuts|lolxdmemes
+
 ## Community Python API
 A community python API wrapper exists [here](https://github.com/735tesla/python-pineapple) but documentation is still in progress.
 

From bf64201ffa5c572b57362183dcf030bd350e10a2 Mon Sep 17 00:00:00 2001
From: Foxtrot <foxtrotnull@gmail.com>
Date: Tue, 12 Jul 2016 13:35:22 +0100
Subject: [PATCH 2/5] Add reference to creating_modules.md

---
 api.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/api.md b/api.md
index 6f500e8..e4e587e 100644
--- a/api.md
+++ b/api.md
@@ -283,7 +283,7 @@ Action|Description|Parameters
 `removeMac`|Removes a MAC from tracking|<ul><li>`mac`<ul><li>The MAC address to stop tracking</li></ul></li>
 
 ## Module.php API
-Every module must extend the `Module` class that resides in `Module.php`. Extending this class gives the module access to the following API functions.
+Every module must extend the `Module` class that resides in `Module.php`. Extending this class gives the module access to the following API functions. For more information, see [Creating Modules](https://wiki.wifipineapple.com/creating_modules.md).
 
 Test|Test|Test
 ----|----|----

From 94500eebd6719aa900386188aee73d36154baf6d Mon Sep 17 00:00:00 2001
From: Foxtrot <foxtrotnull@gmail.com>
Date: Tue, 12 Jul 2016 13:40:03 +0100
Subject: [PATCH 3/5] Add first function

---
 api.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/api.md b/api.md
index e4e587e..c5e6187 100644
--- a/api.md
+++ b/api.md
@@ -285,9 +285,9 @@ Action|Description|Parameters
 ## Module.php API
 Every module must extend the `Module` class that resides in `Module.php`. Extending this class gives the module access to the following API functions. For more information, see [Creating Modules](https://wiki.wifipineapple.com/creating_modules.md).
 
-Test|Test|Test
+Function|Arguments|Description|Usage
 ----|----|----
-deez|nuts|lolxdmemes
+execBackground()|`command`|Will execute `command` in the background.|`$this->execBackground("ifconfig wlan1 down");`
 
 ## Community Python API
 A community python API wrapper exists [here](https://github.com/735tesla/python-pineapple) but documentation is still in progress.

From 80923b5ebd8741cc335a80d0910a4589c8ccc7cb Mon Sep 17 00:00:00 2001
From: Foxtrot <foxtrotnull@gmail.com>
Date: Tue, 12 Jul 2016 13:41:03 +0100
Subject: [PATCH 4/5] Fix table formatting...

---
 api.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/api.md b/api.md
index c5e6187..26478b5 100644
--- a/api.md
+++ b/api.md
@@ -286,7 +286,7 @@ Action|Description|Parameters
 Every module must extend the `Module` class that resides in `Module.php`. Extending this class gives the module access to the following API functions. For more information, see [Creating Modules](https://wiki.wifipineapple.com/creating_modules.md).
 
 Function|Arguments|Description|Usage
-----|----|----
+----|----|----|----
 execBackground()|`command`|Will execute `command` in the background.|`$this->execBackground("ifconfig wlan1 down");`
 
 ## Community Python API

From d870f65e9f7490a4e7717930300d5f01dbf6fe7d Mon Sep 17 00:00:00 2001
From: Foxtrot <foxtrotnull@gmail.com>
Date: Tue, 12 Jul 2016 13:51:24 +0100
Subject: [PATCH 5/5] Complete Module.php section.

---
 api.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/api.md b/api.md
index 26478b5..2975478 100644
--- a/api.md
+++ b/api.md
@@ -287,7 +287,14 @@ Every module must extend the `Module` class that resides in `Module.php`. Extend
 
 Function|Arguments|Description|Usage
 ----|----|----|----
-execBackground()|`command`|Will execute `command` in the background.|`$this->execBackground("ifconfig wlan1 down");`
+execBackground()|`command`|Will execute `command` in the background.|`$this->execBackground("ifconfig wlan1 down");
+installDependency()|`dependencyName`|Will use opkg to install `dependencyName`.|`$this->installDependecy('nmap');`
+checkDependency()|`dependencyName`|Will use opkg to check is `dependencyName` is installed.|`$this->checkDependency('nmap');`
+checkRunning()|`processName`|Will check to see if `processName` is currently running on the system.|`$this->checkRunning('nmap');`
+uciGet()|`uciString`|Will use UCI to get value of supplied `uciString`|`$this->uciGet("network.wan");`
+uciSet()|`settingString`<br>`value`|Will use UCI to set the supplied `value` of supplied `settingString`.|`$this->uciSet("network.wan.ifname", "wan2");`
+uciAddList()|`settingString`<br>`value`|Will use UCI to create a new list with supplied `settingString` and `value`.|`$this->uciAddList("network", "wan3");`
+
 
 ## Community Python API
 A community python API wrapper exists [here](https://github.com/735tesla/python-pineapple) but documentation is still in progress.