User Tools

Site Tools


uphp:uphp_intro

Differences

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

Link to this comparison view

Next revision
Previous revision
uphp:uphp_intro [2018/09/01 10:28]
jeff created with content from uphp (which was from programming_the_wattmon)
uphp:uphp_intro [2021/09/13 05:57] (current)
Line 3: Line 3:
 "Programming" and "scripting" are used interchangeably throughout this documentation. "Programming" and "scripting" are used interchangeably throughout this documentation.
  
-The Wattmon is built on a scripting language that is syntactically identical to PHP((PHP is a server-side scripting language designed primarily for web development but also used as a general-purpose programming language. PHP stands for "PHP: Hypertext Preprocessor." This confuses many people because the first word of the acronym is the acronym (this type of acronym is called a recursive acronym.) )) - we call it uPHP for Micro-PHP.  It has a small but powerful subset of the functions and features found in the PHP language.+The [[hardware:wattmons|Wattmon]] is built on a scripting language that is syntactically identical to PHP((PHP is a server-side scripting language designed primarily for web development but also used as a general-purpose programming language. PHP stands for "PHP: Hypertext Preprocessor." This confuses many people because the first word of the acronym is the acronym (this type of acronym is called a recursive acronym.) )) - we call it uPHP for Micro-PHP.  It has a small but powerful subset of the functions and features found in the PHP language.
  
 =====Why uPHP?===== =====Why uPHP?=====
  
-First perhaps it would be good to explain a bit about how and why we chose PHP.  The goal of the Wattmon is to provide a highly flexible platform that can be customized for pretty much any application imaginable, keeping in mind very low memory availability.  It became clear that a scripting language would be required to implement this, since having custom firmwares for various applications would be very tedious.  The question then became: what would be the *best* scripting language that is well known today and can be deployed on a microcontroller with such limited resource?  The choices are actually very small.  Most modern scripting languages require quite a bit of RAM.  So, we decided to roll our own scripting language from scratch and base it off a well known language.+First perhaps it would be good to explain a bit about how and why we chose PHP.  The goal of the [[hardware:wattmons|Wattmon]] is to provide a highly flexible platform that can be customized for pretty much any application imaginable, keeping in mind very low memory availability.  It became clear that a scripting language would be required to implement this, since having custom firmwares for various applications would be very tedious.  The question then became: what would be the *best* scripting language that is well known today and can be deployed on a microcontroller with such limited resource?  The choices are actually very small.  Most modern scripting languages require quite a bit of RAM.  So, we decided to roll our own scripting language from scratch and base it off a well known language.
  
-The Wattmon interface is primarily browser based, and generates HTML pages on the fly from uPHP scripts.  The methodology of HTML-PHP integration is well understood by most programmers and hence it allows you to become more productive quickly.+The [[hardware:wattmons|Wattmon]] interface is primarily browser based, and generates HTML pages on the fly from uPHP scripts.  The methodology of HTML-PHP integration is well understood by most programmers and hence it allows you to become more productive quickly.
  
 ====Challenges==== ====Challenges====
Line 15: Line 15:
 The biggest challenge with the scripting language is its memory limitation.  The [[hardware:wattmons:WattmonPRO]] and [[hardware:wattmons:WattmonMINI]] processors have a total of 128KB (yes, Kilobytes!) of RAM available to run a multitasking OS with a TCP/IP and USB stack, modbus polling engine, scheduler and more.  For these platforms during normal operation scripts have a maximum of about 30 KB of memory for variables, which means that as a programmer you need to be very conscious of memory allocation.  We have introduced some special non-PHP compatible variable types to help with this.  The [[uphp:functions:indexed_array()]] function lets you create arrays of a very specific type (int, byte, etc) which will reduce the amount of resources compared to hash arrays created with the [[uphp:functions:array()]] function. The biggest challenge with the scripting language is its memory limitation.  The [[hardware:wattmons:WattmonPRO]] and [[hardware:wattmons:WattmonMINI]] processors have a total of 128KB (yes, Kilobytes!) of RAM available to run a multitasking OS with a TCP/IP and USB stack, modbus polling engine, scheduler and more.  For these platforms during normal operation scripts have a maximum of about 30 KB of memory for variables, which means that as a programmer you need to be very conscious of memory allocation.  We have introduced some special non-PHP compatible variable types to help with this.  The [[uphp:functions:indexed_array()]] function lets you create arrays of a very specific type (int, byte, etc) which will reduce the amount of resources compared to hash arrays created with the [[uphp:functions:array()]] function.
  
-The [[hardware:wattmons:WattmonMEGA]] processor has a total of 512KB of RAM (4 times as much as for the PRO and the MINI). Memory limitations are much less of a challenge when scripting for the MEGA.+The [[hardware:wattmons:WattmonMEGA]] processor has a total of 512KB of RAM (4 times as much as for the [[hardware:wattmons:WattmonPRO|PRO]] and the [[hardware:wattmons:WattmonMINI|MINI]]). Memory limitations are much less of a challenge when scripting for the [[hardware:wattmons:WattmonMEGA|MEGA]].
  
 ====Benefits==== ====Benefits====
Line 25: Line 25:
 Of interest to those who want to dig deeper and advance into making tweaks and changes to the system: Of interest to those who want to dig deeper and advance into making tweaks and changes to the system:
  
-[[uphp:uPHP Language Basics]]+[[uphp:uPHP Language Basics]] - Basic syntax and tips to get started
  
-[[uphp:functions|uPHP Function Reference]]+[[uphp:functions|uPHP Function Reference]] - The entire function list (advanced) 
 + 
 +[[uPHP Special Variables]] - Special arrays that are populated automatically before a script is run
  
uphp/uphp_intro.1535797688.txt.gz · Last modified: 2021/09/13 05:56 (external edit)