Wattmon Documentation Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======flash_status======

<badge>FW >= 1295</badge>

The flash_status() function returns information about the onboard flash chip (if any)

====Description====

<well size="sm"><html>
<span style="font-size:125%;color:green">array
<span style="color:black">flash_status (
<span style="color:black">)
</html></well>


====Parameter====

None

====Return Values====

<html><b><span style="color:green">array<span style="color:black"></b></html>:  Return array contains the following elements:

^ Key    ^ Value         ^
| state  | Flash status  |
| percent | Percentage completed |
| size | Size of flash chip |
| mounted | 0=not mounted, 1 = mounted |
| booted | 1 = booted from Flash |
   
<html>The state key will contain one of the following values: </html>

^ state ^ Description ^
| 0 | Idle |
| 1 | Erasing (percent will contain the erased percentage) |
| 2 | Restoring (percent will contain the restored percentage) |
| 3 | Backing up (percent will contain the backed up percentage) |
| 4 | Error |

====Examples====

<code php>
<?
  $flash_status = flash_status();
  if ($flash_status['state']==1) {
    print("Erasing Flash - ".$flash_status['percent']."% completed");
  }
?>
</code>

Wattmon Documentation Wiki

User Tools

Site Tools

Page Tools