Wattmon Documentation Wiki

User Tools

Site Tools

You are here: start » uphp » functions » uphp_function_reference
Trace:
uphp:functions:uphp_function_reference

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
uphp:functions:uphp_function_reference [2017/05/26 18:47]
jeff 		— (current)
Line 1: Line 1:
-======uPHP Reference====== 
- 
-uPHP functions have an identical syntax to PHP functions in most cases. Below is a list of all the functions that have been implemented. 
- 
-Click on the function name for further details: 
- 
-^FUNCTION NAME^PARAMETER(S)^RETURN^DESCRIPTION^ 
-|[[adc_read]]|<html><span style="color:green">int<span style="color:blue"> channel</html>|<html><span style="color:green">int<span style="color:black"> ADC value</html>|Read an onboard <tooltip title="Analog to Digital Converter">ADC</tooltip> <html><span style="color:blue">channel</html>| 
-|[[array]]|<html><span style="color:green">mixed<span style="color:blue"> values<span style="color:black"> ...</html>|<html><span style="color:green">array</html>|<html>Create an <span style="color:green">array<span style="color:black">, with optional <html><span style="color:blue">values</html>| 
-|[[array_key]]|<html><span style="color:green">array<span style="color:black">, <span style="color:green"> int<span style="color:blue"> index</html>|<html><span style="color:green">string<span style="color:black"> key</html>|<html>Return the key for an <span style="color:green">array <span style="color:blue">index</html>| 
-|[[array_keys]]|<html><span style="color:green">array<span style="color:black"> with key/value pairs</html>|<html><span style="color:green">array<span style="color:black"> of keys</html>|<html>Return keys for an <span style="color:green">array<span style="color:black"> that has key/value pairs</html>| 
-|[[base64_decode]]|<html><span style="color:green">string<span style="color:blue"> base64</html>|<html><span style="color:green">string<span style="color:black"> decoded or <span style="color:green">int<span style="color:black"> 0</html>|<html>Decode a base64-encoded <span style="color:green">string</html>| 
-|[[base64_encode]]|<html><span style="color:green">string<span style="color:black"> to encode</html>|<html><span style="color:green">string<span style="color:black"> base64 or <span style="color:green">int<span style="color:black"> 0</html>|<html>Return the base64-encoded version of a <span style="color:green">string</html>| 
-|[[call_user_func]]|<html><span style="color:green">string<span style="color:blue"> function_name<span style="color:black">,<span style="color:green"> mixed<span style="color:blue"> parameters<span style="color:black"> ...</html>|<html><span style="color:green">mixed<span style="color:black"> result</html>|<html>Call a user defined function with optional <span style="color:blue">parameters</html>| 
-|[[charat]]|<html><span style="color:green">string<span style="color:black">,<span style="color:green"> int<span style="color:blue"> index</html>|<html><span style="color:green">int<span style="color:black"> ASCII code</html>|<html>Return the ASCII code for a character in a <span style="color:green">string<span style="color:black"> at an<span style="color:blue"> index</html>| 
-|[[chdir]]|<html><span style="color:green">string<span style="color:blue"> directory</html>|<html><span style="color:green">int<span style="color:black"> 0=OK</html>|Change the current directory| 
-|[[chr]]|<html><span style="color:green">int<span style="color:blue"> code</html>|<html><span style="color:green">string<span style="color:black"> 1 character</html>|<html>Return the character for an ASCII <span style="color:blue">code</html>| 
-|[[cos]]|<html><span style="color:green">number<span style="color:blue"> radian_angle</html>|<html><span style="color:green">float<span style="color:black"> cosine</html>|<html>Return cosine of a <span style="color:blue">radian_angle</html>| 
-|[[debug]]|<html><span style="color:green">string<span style="color:blue"> output</html>||Print to debug output| 
-|[[debugout]]|<html><span style="color:green">int<span style="color:blue"> 0 or 1</html>||Enable or disable debug messages| 
-|[[die]]|||Kill the script| 
-|[[disk_free_space]]||<html><span style="color:green">int<span style="color:black"> KiloBytes</html>|Return free space on microSD card| 
-|[[disk_total_space]]||<html><span style="color:green">int<span style="color:black"> KiloBytes</html>|Return total space on microSD card| 
-|[[error_reporting]]|<html><span style="color:green">int<span style="color:blue"> verbosity</html>||Set the debug output level| 
-|[[exec]]|<html><span style="color:green">string<span style="color:blue"> script<span style="color:black">,<span style="color:green"> int<span style="color:blue"> delay</html>||<html>Run a <span style="color:blue">script<span style="color:black"> with an optional <span style="color:blue">delay</html>| 
-|[[exec_action]]|<html><span style="color:green">mixed<span style="color:blue"> action</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|<html>Triggers a manually executable <span style="color:blue">action<span style="color:black"> by id or name</html>| 
-|[[explode]]|<html><span style="color:green">string<span style="color:black">,<span style="color:green"> string<span style="color:blue"> delimiter</html>|<html><span style="color:green">array</html>|<html>Turn a <span style="color:green">string<span style="color:black"> into an <span style="color:green">array</html>| 
-|[[f485open]]|<html><span style="color:green">int<span style="color:blue"> baud<span style="color:black">,<span style="color:green"> int<span style="color:blue"> parity</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|<html>Open the RS-485 port at the specified <span style="color:blue">baud<span style="color:black"> rate and <span style="color:blue">parity</html>| 
-|[[fclose]]|<html><span style="color:green">int<span style="color:blue"> handle</html>||Close a file, stream or socket| 
-|[[feof]]|<html><span style="color:green">int<span style="color:blue"> handle</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|Test if no more data is available in a file, stream or socket| 
-|[[fgets]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<span style="color:green"> int<span style="color:blue"> size</html>|<html><span style="color:green">string<span style="color:black"> or <span style="color:green">int<span style="color:black"> -1</html>|<html>Return a single line from a file, stream or socket, with optional <span style="color:blue">size<span style="color:black"> limit</html>| 
-|[[file_exists]]|<html><span style="color:green">string<span style="color:blue"> filename</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|Check if a file exists| 
-|[[filesize]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black"> or<span style="color:green"> int<span style="color:blue"> handle</html>|<html><span style="color:green">int<span style="color:black"> bytes</html>|Return the size of a file, or the number of unread bytes in a stream or socket| 
-|[[findfirst]]|<html><span style="color:green">string<span style="color:blue"> pattern<span style="color:black">,<span style="color:green"> int<span style="color:blue"> attributes</html>|<html><span style="color:green">array<span style="color:black"> first file found</html>|<html>Start searching the current folder for files matching a <span style="color:blue">pattern<span style="color:black"> and <span style="color:blue">attributes</html>| 
-|[[findnext]]||<html><span style="color:green">array<span style="color:black"> next file found</html>|Return next matching file information (after a findfirst)| 
-|[[firmwareupdate]]|||Initiate a firmware update sequence and reboot the device| 
-|[[floatval]]|<html><span style="color:green">mixed<span style="color:blue"> value</html>|<html><span style="color:green">float<span style="color:black"> value or <span style="color:green">int<span style="color:black"> 0/1</html>|<html>Return the <span style="color:green">float<span style="color:black"> value of a <span style="color:green">number<span style="color:black"> or <span style="color:green">string</html>| 
-|[[flush]]|||Flush current output to the browser| 
-|[[fopen]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> mode</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|Open a file for reading or writing| 
-|[[fread]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<span style="color:green"> int<span style="color:blue"> bytes</html>|<html><span style="color:green">string<span style="color:black"> or <span style="color:green">int<span style="color:black"> 0</html>|<html>Read <span style="color:blue">bytes<span style="color:black"> from a file, stream or socket</html>| 
-|[[freemem]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free memory space| 
-|[[freestack]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free stack space| 
-|[[fseek]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<span style="color:green"> int<span style="color:blue"> offset<span style="color:black">,<span style="color:green"> int<span style="color:blue"> whence</html>||Position the file pointer in an open file| 
-|[[fseropen]]|<html><span style="color:green">int<span style="color:blue"> baud<span style="color:black">,<span style="color:green"> int<span style="color:blue"> blocking<span style="color:black">,<span style="color:green"> int<span style="color:blue"> invert<span style="color:black">,<span style="color:green"> int<span style="color:blue"> parity</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|<html>Open the serial port at the specified <span style="color:blue">baud<span style="color:black"> rate with optional parameters</html>| 
-|[[fsockopen]]|<html><span style="color:green">string<span style="color:blue"> host<span style="color:black">,<span style="color:green"> int<span style="color:blue"> port<span style="color:black">,<span style="color:green"> int<span style="color:blue"> timeout</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|<html>Open an internet socket connection with optional <span style="color:blue">timeout</html>| 
-|[[ftell]]|<html><span style="color:green">int<span style="color:blue"> handle</html>|<html><span style="color:green">int<span style="color:black"> position</html>|Return the current position of a file read/write pointer| 
-|[[function_exists]]|<html><span style="color:green">string<span style="color:blue"> function_name</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|Check if a function exists (custom or native)| 
-|[[fwrite]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">, <span style="color:green">mixed <span style="color:blue">data</html>|<html><span style="color:green">int<span style="color:black"> bytes written or -1</html>|<html>Write <span style="color:blue">data<span style="color:black"> to a file, stream or socket</html>| 
-|[[get3gstat]]||<html><span style="color:green">array</html>|Get cellular data connection status information| 
-|[[getcwd]]||<html><span style="color:green">string<span style="color:black"> path</html>|Get the current directory| 
-|[[getethstat]]||<html><span style="color:green">array</html>|Get Ethernet connection status information| 
-|[[getmac]]||<html><span style="color:green">string<span style="color:black"> MAC</html>|Get the Wattmon's MAC address| 
-|[[getusbstat]]||<html><span style="color:green">array</html>|Get USB host status information| 
-|[[header]]|<html><span style="color:green">string<span style="color:blue"> header_data</html>||Add to HTTP header| 
-|[[htmlspecialchars]]|<html><span style="color:green">string<span style="color:blue"> data</html>|<html><span style="color:green">string<span style="color:black"> converted</html>|Convert special characters for display in HTML| 
-|[[ieee754toint]]|<html><span style="color:green">float <span style="color:blue">value</html>|<html><span style="color:green">int<span style="color:black"> representation</html>|<html>Convert a <span style="color:green">float <span style="color:blue">value<span style="color:black"> to an IEEE-754 encoded <span style="color:green">integer<span style="color:black"> (32 bit)</html>| 
-|[[implode]]|<html><span style="color:green">array<span style="color:black">,<span style="color:green"> string<span style="color:blue"> delimiter</html>|<html><span style="color:green">string</html>|<html>Turn an <span style="color:green">array<span style="color:black"> into a <span style="color:green">string</html>| 
-|[[include]]|<html><span style="color:green">string<span style="color:blue"> filename</html>||Include a file within the current script at the current location| 
-|[[indexed_array]]|<html><span style="color:green">int<span style="color:blue"> type<span style="color:black">,<span style="color:green"> int<span style="color:blue"> size</html>|<html><span style="color:green">array</html>|<html>Create an <span style="color:green">array<span style="color:black"> of a specific <span style="color:blue">type<span style="color:black"> and <span style="color:blue">size</html>| 
-|[[ini_get]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> section<span style="color:black">,<span style="color:green"> string<span style="color:blue"> key<span style="color:black">,<span style="color:green"> mixed<span style="color:blue"> default</html>|<html><span style="color:green">mixed<span style="color:black"> value</html>|Get a value from an INI file| 
-|[[ini_get_array]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> section</html>|<html><span style="color:green">array</html>|Get a group of parameters from an INI file as an <html><span style="color:green">array<span style="color:black"></html>| 
-|[[ini_put_array]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> array<span style="color:blue"> data<span style="color:black">,<span style="color:green"> string<span style="color:blue"> section</html>||Write a group of parameters to an INI file from an <html><span style="color:green">array<span style="color:black"></html>| 
-|[[ini_set]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> section<span style="color:black">,<span style="color:green"> string<span style="color:blue"> key<span style="color:black">,<span style="color:green"> mixed<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Set a <html><span style="color:blue">value<span style="color:black"></html> in an INI file| 
-|[[inttoieee754]]|<html><span style="color:green">int <span style="color:blue">representation</html>|<html><span style="color:green">float<span style="color:black"> value</html>|<html>Convert an IEEE-754 encoded <span style="color:green">integer <span style="color:blue">representation<span style="color:black"> (32 bit) to a <span style="color:green">float</html>| 
-|[[intval]]|<html><span style="color:green">mixed<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> value</html>|<html>Return the <span style="color:green">integer<span style="color:black"> value of a <span style="color:green">number<span style="color:black"> or <span style="color:green">string</html>| 
-|[[is_array]]|<html><span style="color:green">mixed<span style="color:blue"> variable</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">variable<span style="color:black"> is an <span style="color:green">array</html>| 
-|[[is_float]]|<html><span style="color:green">mixed<span style="color:blue"> variable</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">variable<span style="color:black"> is a <span style="color:green">float</html>| 
-|[[is_int]]|<html><span style="color:green">mixed<span style="color:blue"> variable</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">variable<span style="color:black"> is an <span style="color:green">integer</html>| 
-|[[is_numeric]]|<html><span style="color:green">mixed<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">value<span style="color:black"> is numeric (<span style="color:green">int<span style="color:black">, <span style="color:green">float<span style="color:black"> or numeric <span style="color:green">string)</html>| 
-|[[is_string]]|<html><span style="color:green">mixed<span style="color:blue"> variable</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">variable<span style="color:black"> is a <span style="color:green">string</html>| 
-|[[isset]]|<html><span style="color:green">mixed<span style="color:blue"> variable</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|<html>Check if a <span style="color:blue">variable<span style="color:black"> exists</html>| 
-|[[json_encode]]|<html><span style="color:green">array<span style="color:black">,<span style="color:green"> int<span style="color:blue"> method</html>|<html><span style="color:green">string</html>|<html>JSON encode an <span style="color:green">array<span style="color:black"> into a <span style="color:green">string<span style="color:black">, with optional <span style="color:blue">method</html>| 
-|[[ln]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">float<span style="color:black"> log<sub>e</sub></html>|Return the natural logarithm of a <html><span style="color:blue">number</html>| 
-|[[log]]|<html><span style="color:green">string<span style="color:blue"> output<span style="color:black">,<span style="color:green"> string<span style="color:blue"> file</html>||<html>Print to the System Log (or optional <span style="color:blue">file<span style="color:black">)</html>| 
-|[[log10]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">float<span style="color:black"> log<sub>10</sub></html>|Return the base 10 logarithm of a <html><span style="color:blue">number</html>| 
-|[[mail]]|<html><span style="color:green">string<span style="color:blue"> recipient<span style="color:black">,<span style="color:green"> string<span style="color:blue"> subject<span style="color:black">,<span style="color:green"> string<span style="color:blue"> body</html>|<html><span style="color:green">int<span style="color:black"> 0 or SMTP error code</html>|Send an email| 
-|[[max_execution_time]]|<html><span style="color:green">int<span style="color:blue"> seconds</html>||Set the maximum execution time for the current script| 
-|[[mb_add_dev]]|<html><span style="color:green">int<span style="color:blue"> id<span style="color:black">,<span style="color:green"> int<span style="color:blue"> type<span style="color:black">,<span style="color:green"> string<span style="color:blue"> name<span style="color:black">,<span style="color:green"> int<span style="color:blue"> poll_interval<span style="color:black">,<span style="color:green"> int<span style="color:blue"> status</html>|<html><span style="color:green">int<span style="color:black"> 0=OK</html>|Add a device to the list of polled devices| 
-|[[mb_delete_device]]|<html><span style="color:green">int<span style="color:blue"> id</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Delete a device from the list of active devices| 
-|[[mb_get_dev_by_id]]|<html><span style="color:green">int<span style="color:blue"> id</html>|<html><span style="color:green">array</html>|Return modbus device details by <html><span style="color:blue">id</html>| 
-|[[mb_get_dev_by_index]]|<html><span style="color:green">int<span style="color:blue"> index</html>|<html><span style="color:green">array</html>|Return modbus device details by <html><span style="color:blue">index</html>| 
-|[[mb_get_dev_by_name]]|<html><span style="color:green">string<span style="color:blue"> name</html>|<html><span style="color:green">array</html>|Return modbus device details by <html><span style="color:blue">name</html>| 
-|[[mb_get_dev_info]]|<html><span style="color:green">int<span style="color:blue"> type</html>|<html><span style="color:green">array</html>|Return modbus device details by <html><span style="color:blue">type</html>| 
-|[[mb_get_role_array]]||<html><span style="color:green">array</html>|Return an <html><span style="color:green">array<span style="color:black"></html> of all roles and their values| 
-|[[mb_get_status_by_role]]|<html><span style="color:green">int<span style="color:blue"> role</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Return status of the device attached to the <html><span style="color:blue">role</html>| 
-|[[mb_get_val_by_role]]|<html><span style="color:green">int<span style="color:blue"> role</html>|<html><span style="color:green">number</html>|Return value of the <html><span style="color:blue">role</html>| 
-|[[mb_num_devices]]||<html><span style="color:green">int</html>|Return number of devices on the modbus| 
-|[[mb_queue_command]]|<html><span style="color:green">mixed<span style="color:blue"> values<span style="color:black"> ...</html>|<html><span style="color:green">array<span style="color:black"> of numbers</html>|Queue a sequence of characters to the rs485 bus and get but ignore the reply| 
-|[[mb_scan_complete]]||<html><span style="color:green">int<span style="color:black"> 1=complete, 0=ongoing</html>|Check to see if a modbus scan has completed| 
-|[[mb_scan_percent]]||<html><span style="color:green">number<span style="color:black"> percent completed</html>|Return scan percentage completed| 
-|[[mb_send_command]]|<html><span style="color:green">mixed<span style="color:blue"> values<span style="color:black"> ...</html>|<html><span style="color:green">array<span style="color:black"> of numbers</html>|Send a sequence of characters to the rs485 bus and get a reply| 
-|[[mb_set_dev_var]]|<html><span style="color:green">string<span style="color:blue"> name<span style="color:black"> or<span style="color:green"> int<span style="color:blue"> id<span style="color:black">,<span style="color:green"> string<span style="color:blue"> variable<span style="color:black">,<span style="color:green"> mixed<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Set a <html><span style="color:blue">variable<span style="color:black"></html> on a modbus device| 
-|[[mb_set_val_by_role]]|<html><span style="color:green">int<span style="color:blue"> role<span style="color:black">,<span style="color:green"> number<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Set a <html><span style="color:blue">role value<span style="color:black"></html> on a modbus device| 
-|[[mb_start_scan]]|<html><span style="color:green">int<span style="color:blue"> start<span style="color:black">,<span style="color:green"> int<span style="color:blue"> end</html>||Initiate an automatic scan of the modbus| 
-|[[md5]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">string<span style="color:black"> 32 characters</html>|Calculate the MD5 hash of a <html><span style="color:green">string</html>| 
-|[[md5_file]]|<html><span style="color:green">string<span style="color:blue"> filename</html>|<html><span style="color:green">string<span style="color:black"> 32 characters</html>|Calculate the MD5 hash of a file| 
-|[[mem_dump]]|||Write the current memory map to /dump.txt| 
-|[[mem_usage]]|||Write memory usage to standard output| 
-|[[microtime]]||<html><span style="color:green">int<span style="color:black"> ms</html>|Return the number of milliseconds since boot| 
-|[[mkdir]]|<html><span style="color:green">string<span style="color:blue"> pathname</html>|<html><span style="color:green">int<span style="color:black"> 0 or error code</html>|Make a directory| 
-|[[mktime]]|<html><span style="color:green">int<span style="color:blue"> hour<span style="color:black">,<span style="color:green"> int<span style="color:blue"> minute<span style="color:black">,<span style="color:green"> int<span style="color:blue"> second<span style="color:black">,<span style="color:green"> int<span style="color:blue"> month<span style="color:black">,<span style="color:green"> int<span style="color:blue"> day<span style="color:black">,<span style="color:green"> int<span style="color:blue"> year</html>|<html><span style="color:green">int<span style="color:black"> seconds</html>|Return the Linux Timestamp for a given date and time| 
-|[[net_disable3g]]|||Disable 3G support for the dongle| 
-|[[net_enable3g]]|||Enable 3G support for the dongle| 
-|[[netstat]]||<html><span style="color:green">array</html>|Get Ethernet information| 
-|[[number_format]]|<html><span style="color:green">mixed <span style="color:blue">number<span style="color:black">,<span style="color:green"> int<span style="color:blue"> digits</html>|<html><span style="color:green">string<span style="color:black"> formatted</html>|<html>Return the <span style="color:green">string<span style="color:black"> value of a <span style="color:blue">number<span style="color:black"> formatted to a particular precision</html>| 
-|[[nvram_backup]]|<html><span style="color:green">string<span style="color:blue"> filename</html>|<html><span style="color:green">int<span style="color:black"> bytes written or 0=error</html>|Backup the contents of <tooltip title="Non-Volatile RAM">NVRAM</tooltip> to a file on the SD Card| 
-|[[nvram_defrag]]|||Defragment <tooltip title="Non-Volatile RAM">NVRAM</tooltip> to optimise it| 
-|[[nvram_dump]]|||Dump the contents of <tooltip title="Non-Volatile RAM">NVRAM</tooltip> to standard output| 
-|[[nvram_free]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return the number of bytes available in <tooltip title="Non-Volatile RAM">NVRAM</tooltip>| 
-|[[nvram_get]]|<html><span style="color:green">string<span style="color:blue"> key</html>|<html><span style="color:green">mixed<span style="color:black"> value</html>|Get a value from <tooltip title="Non-Volatile RAM">NVRAM</tooltip>| 
-|[[nvram_restore]]|<html><span style="color:green">string <span style="color:blue">filename</html>||Restore the contents of <tooltip title="Non-Volatile RAM">NVRAM</tooltip> from a file| 
-|[[nvram_set]]|<html><span style="color:green">string<span style="color:blue"> key<span style="color:black">,<span style="color:green"> string<span style="color:blue"> value</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|<html>Set a <span style="color:blue">key<span style="color:black"> and <span style="color:blue">value<span style="color:black"> in </html><tooltip title="Non-Volatile RAM">NVRAM</tooltip>| 
-|[[nvram_unset]]|<html><span style="color:green">string<span style="color:blue"> key</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|Clear a <html><span style="color:blue">key<span style="color:black"></html> from <tooltip title="Non-Volatile RAM">NVRAM</tooltip>| 
-|[[ord]]|<html><span style="color:green">string<span style="color:blue"> character</html>|<html><span style="color:green">int<span style="color:black"> ASCII code</html>|Return the ASCII code for a <html><span style="color:blue">character</html>| 
-|[[ow_first]]||<html><span style="color:green">array<span style="color:black"> or <span style="color:green">int<span style="color:black"> 0</html>|Initiate a OneWire bus scan and return the address of the first device found| 
-|[[ow_next]]||<html><span style="color:green">array<span style="color:black"> or <span style="color:green">int<span style="color:black"> 0</html>|Return the address of the next OneWire device found (after an ow_first)| 
-|[[ow_read]]||<html><span style="color:green">int<span style="color:black"> value or 0</html>|Read a byte from the OneWire bus| 
-|[[ow_read_temp]]|<html><span style="color:green">array<span style="color:blue"> device_id</html>|<html><span style="color:green">float<span style="color:black"> degrees Celsius</html>|Read a temperature from a device on the OneWire bus| 
-|[[ow_reset]]|||Reset the OneWire bus| 
-|[[ow_write]]|<html><span style="color:green">int<span style="color:blue"> value</html>||Write a byte to the OneWire bus| 
-|[[phpinfo]]||<html><span style="color:green">string</html>|Return information about the system| 
-|[[pin_configure]]|<html><span style="color:green">int<span style="color:blue"> pin_index<span style="color:black">,<span style="color:green"> int<span style="color:blue"> pin_type<span style="color:black">,<span style="color:green"> int<span style="color:blue"> counter_type</html>||Configure an <tooltip title="Input/Output">IO</tooltip> pin as a digital input, output, or analog input| 
-|[[pin_get]]|<html><span style="color:green">int<span style="color:blue"> pin_index<span style="color:black">,<span style="color:green"> int<span style="color:blue"> pin_type</html>|<html><span style="color:green">int<span style="color:black"> value</html>|Return the value of an <tooltip title="Input/Output">IO</tooltip> pin| 
-|[[pin_set]]|<html><span style="color:green">int<span style="color:blue"> pin_index<span style="color:black">,<span style="color:green"> int<span style="color:blue"> value</html>||Set a digital output to <html><span style="color:blue">value<span style="color:black"></html> 1 or 0| 
-|[[ping]]|<html><span style="color:green">string<span style="color:blue"> host</html>|<html><span style="color:green">array</html>|Send an ICMP ping and place the result in an <html><span style="color:green">array<span style="color:black"></html>| 
-|[[power]]|<html><span style="color:green">number<span style="color:blue"> base<span style="color:black">,<span style="color:green"> number<span style="color:blue"> exp</html>|<html><span style="color:green">number<span style="color:blue"> base<sup>exp</sup></html>|<html>Return <span style="color:blue">base<span style="color:black"> raised to the power of <span style="color:blue">exp</html>| 
-|[[print]]|<html><span style="color:green">string<span style="color:blue"> data</html>||Print <html><span style="color:blue">data<span style="color:black"></html> to the current output stream such as a web page or terminal| 
-|[[print_r]]|<html><span style="color:green">array</html>||<html>Dump the contents of an <span style="color:green">array<span style="color:black"> to the current output</html>| 
-|[[printf]]|<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">, <span style="color:green">mixed<span style="color:blue"> values<span style="color:black"> ...</html>||Print a formatted <html><span style="color:green">string<span style="color:black"></html> to standard output| 
-|[[process_kill]]|<html><span style="color:green">int<span style="color:blue"> pid</html>||Send a kill request to a process| 
-|[[process_list]]||<html><span style="color:green">array</html>|Return an <html><span style="color:green">array<span style="color:black"></html> of the currently running scripts| 
-|[[rand]]|<html><span style="color:green">int<span style="color:blue"> min<span style="color:black">, <span style="color:green">int<span style="color:blue"> max</html>|<html><span style="color:green">int</html>|<html>Return a random <span style="color:green">integer<span style="color:black"> between <span style="color:blue">min<span style="color:black"> and <span style="color:blue">max</html>| 
-|[[reboot]]|||Reboot the processor| 
-|[[rename]]|<html><span style="color:green">string<span style="color:blue"> source<span style="color:black">, <span style="color:green">string<span style="color:blue"> destination</html>|<html><span style="color:green">int<span style="color:black"> 0 or error code</html>|<html>Rename or move a file or directory from <span style="color:blue">source<span style="color:black"> to <span style="color:blue">destination</html>| 
-|[[reset]]|||Reset the processor| 
-|[[rmdir]]|<html><span style="color:green">string<span style="color:blue"> pathname<span style="color:black">,<span style="color:green"> int<span style="color:blue"> delete_contents</html>|<html><span style="color:green">int<span style="color:black"> 0=OK</html>|Remove a directory, with optional deletion of contents| 
-|[[session_destroy]]|||Clear the current session's data| 
-|[[session_is_new]]||<html><span style="color:green">int</html>|Check if a session was just initiated| 
-|[[session_start]]|||Initiate a new session and send the cookie data for it| 
-|[[set_search_path]]|<html><span style="color:green">string<span style="color:blue"> pathname</html>||Set the search path for the telnet client| 
-|[[setethpower]]|<html><span style="color:green">int<span style="color:blue"> state</html>||Enable or disable the ethernet controller| 
-|[[setpriority]]|<html><span style="color:green">int<span style="color:blue"> priority</html>||Set the <html><span style="color:blue">priority<span style="color:black"></html> of the current script| 
-|[[settime]]|<html><span style="color:green">int<span style="color:blue"> timestamp<span style="color:black">,<span style="color:green"> int<span style="color:blue"> calibration</html>||<html>Set the system time from a Linux <span style="color:blue">Timestamp<span style="color:black">, with optional <span style="color:blue">calibration</html>| 
-|[[setusbpower]]|<html><span style="color:green">int<span style="color:blue"> state</html>||Enable or disable USB power| 
-|[[sha1]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">string<span style="color:black"> 40 characters</html>|Calculate the SHA1 hash of a <html><span style="color:green">string</html>| 
-|[[sin]]|<html><span style="color:green">number<span style="color:blue"> radian_angle</html>|<html><span style="color:green">float<span style="color:black"> sine</html>|<html>Return sine of a <span style="color:blue">radian_angle<span style="color:black"></html>| 
-|[[sizeof]]|<html><span style="color:green">array</html>|<html><span style="color:green">int<span style="color:black"> number of elements</html>|<html>Return the number of elements in an <span style="color:green">array</html>| 
-|[[sleep]]|<html><span style="color:green">int<span style="color:blue"> ms</html>||Sleep for specified milliseconds| 
-|[[spi_clearcs]]|||Clear the CS output of the <tooltip title="Serial Peripheral Interface">SPI</tooltip> bus| 
-|[[spi_read]]||<html><span style="color:green">int<span style="color:black"> byte</html>|Read a byte from the <tooltip title="Serial Peripheral Interface">SPI</tooltip> bus| 
-|[[spi_setcs]]|||Set the CS output of the <tooltip title="Serial Peripheral Interface">SPI</tooltip> bus| 
-|[[spi_write]]|<html><span style="color:green">int<span style="color:blue"> byte</html>||Write a <html><span style="color:blue">byte<span style="color:black"></html> to the <tooltip title="Serial Peripheral Interface">SPI</tooltip> bus| 
-|[[sprintf]]|<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">, <span style="color:green">mixed<span style="color:blue"> values<span style="color:black"> ...</html>|<html><span style="color:green">string<span style="color:black"> formatted</html>|Return a formatted <html><span style="color:green">string</html>| 
-|[[sqr]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">number<span style="color:black"> squared</html>|Return the square of a <html><span style="color:blue">number</html>| 
-|[[sqrt]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">number<span style="color:black"> square root</html>|Return the square root of a <html><span style="color:blue">number</html>| 
-|[[stats]]||<html><span style="color:green">array</html>|Return system statistics| 
-|[[strftime]]|<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">,<span style="color:green"> int<span style="color:blue"> timestamp</html>|<html><span style="color:green">string<span style="color:black"> formatted</html>|<html>Format a Linux <span style="color:blue">Timestamp<span style="color:black"> using a <span style="color:blue">format <span style="color:green">string</html>| 
-|[[strlen]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">int<span style="color:black"> length</html>|Return the length of a <html><span style="color:green">string</html>| 
-|[[strpos]]|<html><span style="color:green">string<span style="color:blue"> haystack<span style="color:black">, <span style="color:green">string<span style="color:blue"> needle</html>|<html><span style="color:green">int<span style="color:black"> position or -1</html>|<html>Return the position of the first occurrence of a <span style="color:blue">needle<span style="color:black"> in a <span style="color:blue">haystack<span style="color:black"></html>| 
-|[[strrpos]]|<html><span style="color:green">string<span style="color:blue"> haystack<span style="color:black">, <span style="color:green">string<span style="color:blue"> needle</html>|<html><span style="color:green">int<span style="color:black"> position or -1</html>|<html>Return the position of the last occurrence of a <span style="color:blue">needle<span style="color:black"> in a <span style="color:blue">haystack<span style="color:black"></html>| 
-|[[strtolower]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">string<span style="color:black"> lowercase</html>|Return the lowercase version of a <html><span style="color:green">string</html>| 
-|[[strtoupper]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">string<span style="color:black"> UPPERCASE</html>|Return the UPPERCASE version of a <html><span style="color:green">string</html>| 
-|[[strval]]|<html><span style="color:green">mixed<span style="color:blue"> value</html>|<html><span style="color:green">string</html>|<html>Return the <span style="color:green">string<span style="color:black"> equivalent of a <span style="color:green">number</html>| 
-|[[substr]]|<html><span style="color:green">string<span style="color:blue"> input<span style="color:black">,<span style="color:green"> int<span style="color:blue"> start<span style="color:black">,<span style="color:green"> int<span style="color:blue"> length</html>|<html><span style="color:green">string<span style="color:black"> substring</html>|Return part of a <html><span style="color:green">string</html>| 
-|[[tar_finish]]|number handle||Add the ending header to a TAR file| 
-|[[tar_put]]|number handle, string filename|number (1=OK)|Add a file to an open file in TAR format| 
-|[[time]]||<html><span style="color:green">int<span style="color:black"> seconds</html>|Return the current system timestamp| 
-|[[timefromfat]]|<html><span style="color:green">int<span style="color:blue"> filetime</html>|<html><span style="color:green">int<span style="color:black"> seconds</html>|Convert a FAT <html><span style="color:blue">filetime<span style="color:black"></html> to a Linux Timestamp| 
-|[[ucfirst]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">string<span style="color:black"> Proper Case</html>|<html>Convert a <span style="color:green">string<span style="color:black"> to lowercase except for the first character of each word</html>| 
-|[[unlink]]|string filename|Number (0=OK)|Remove a file (delete it)| 
-|[[untar]]|string filename, number verbose||Expand a file into the current folder, optionally verbose| 
-|[[uptime]]||<html><span style="color:green">int<span style="color:black"> ms</html>|Return the uptime in milliseconds| 
-|[[usbinfo]]||array|Get information about the USB state| 
  
uphp/functions/uphp_function_reference.1495824454.txt.gz · Last modified: 2021/09/13 05:56 (external edit)

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki