On this page
article
Wifi Pineapple Nano / Tetra Module Api Module.php Api
Attention - End of Life Product
The WiFi Pineapple Nano & Tetra devices have reached end-of-life status and are no longer sold.
If you are looking for information on modern WiFi Pineapple devices such as the WiFi Pineapple Mark VII, please start here
If you are looking for information on modern WiFi Pineapple devices such as the WiFi Pineapple Mark VII, please start here
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.
| Function | Arguments | Description | Usage |
|---|---|---|---|
| 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() |
|
Will use UCI to set the supplied value of supplied settingString. |
$this->uciSet("network.wan.ifname", "wan2"); |
| uciAddList() |
|
Will use UCI to create a new list with supplied settingStringand value. |
$this->uciAddList("network", "wan3"); |