WiFi Pineapple - 6th Gen: NANO / TETRA
  • WiFi Pineapple NANO/TETRA
  • Getting Started
    • About the WiFi Pineapple NANO/TETRA
    • The WiFi Auditing Workflow
    • The PineAP Suite
    • The Web Interface
    • Upgrading the Firmware
  • Setup
    • Setup Basics
    • WiFi Pineapple NANO - Linux Setup
    • WiFi Pineapple NANO - Windows Setup
    • WiFi Pineapple TETRA - Linux Setup
  • Internet Connectivity
    • Internet Connectivity Basics
    • Internet Connection Sharing on Kali Linux
    • Internet Connection Sharing over Ethernet in Windows
    • Internet Connection Sharing over Ethernet in Linux
    • Wired Internet Connection
    • WiFi Client Mode
  • Console Access
    • Console Access Basics
    • Secure Shell
    • Serial Access - WiFi Pineapple TETRA
    • Working with PineAP from the CLI
  • Basics of WiFi Operation
    • Basics of WiFi Operation
    • Radios and Chipsets
    • Stations and Base Stations
    • Transmit Power
    • Channels and Regions
    • Protocols
    • Modes of Operation
    • Logical Configurations
    • MAC Address
    • Broadcast Address
    • Service Sets and Identifiers
    • Management Frames
    • Frame Types
    • Frames and Frame Structure
    • Frame Injection
    • Association States
  • FAQ / Troubleshooting
    • Serial Console on the WiFi Pineapple TETRA
    • Ethernet on the WiFi Pineapple TETRA
    • LED Status Indicators
    • Power Considerations
    • Factory Reset
    • Firmware Recovery
    • Manual Firmware Installation
  • Development
    • Legacy WiFi Pineapple Mark V Modules (Infusions)
    • Specifications and Power Considerations
    • WiFi Pineapple NANO/TETRA Module API - Introduction
    • WiFi Pineapple NANO/TETRA Module API - Authentication
    • WiFi Pineapple NANO/TETRA Module API - Modules
    • WiFi Pineapple NANO/TETRA Module API - module.php API
    • Creating WiFi Pineapple NANO/TETRA Modules
Powered by GitBook
On this page
  1. Development

WiFi Pineapple NANO/TETRA Module API - module.php API

PreviousWiFi Pineapple NANO/TETRA Module API - ModulesNextCreating WiFi Pineapple NANO/TETRA Modules

Last updated 3 years ago

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 .

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()

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 settingStringand value.

$this->uciAddList("network", "wan3");

Creating Modules