From d870f65e9f7490a4e7717930300d5f01dbf6fe7d Mon Sep 17 00:00:00 2001 From: Foxtrot Date: Tue, 12 Jul 2016 13:51:24 +0100 Subject: [PATCH] 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`
`value`|Will use UCI to set the supplied `value` of supplied `settingString`.|`$this->uciSet("network.wan.ifname", "wan2");` +uciAddList()|`settingString`
`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.