webCoRE Wiki - Web-enabled Community's own Rule Engine - User contributions [en]

File:Weather Hourly.png

2017-10-26T16:27:55Z

Ahndee: Ahndee uploaded a new version of File:Weather Hourly.png

File:Weather Daily.png

2017-10-26T16:27:27Z

Ahndee: Ahndee uploaded a new version of File:Weather Daily.png

Samples

2017-10-26T16:26:26Z

Ahndee: /* Weather Tiles */

This is an ongoing library of examples so please let me know what else you would like to see on here. Please get a hold of [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar]  on the ST forums if you would like to see anything added to this page.

= Simple Pistons =
These are going to be pretty basic beginner level pistons.
== Motion Based ==
*'''Simple Motion Piston'''
: When the motion sensor changes to active, a light will turn on. <code>'''hsv3h'''</code>
::[[File:simplemotion.png]]
*'''Complex Motion Piston'''
::This piston will turn on a light with motion and off after 2 minutes of no motion. <code>'''p3rz7'''</code>
::[[File:complexmotionv2.png]]

== Motion Based EXCEPT When Manually Turned On ==
*'''Advanced Motion Piston'''
::This piston will turn on a light with motion and off after 5 minutes of no motion. But if user switches the light on it will not be turned off by motion, instead user will need to turn if off. If motion turned on the light and you want it to stay on till you turn it off, just switch the light off and on. The isBetween check sets the light level to 100% when between 4am to 11pm otherwise to 10% only when turned on by motion. note that while i use a light in this example it could be any device controlled by motion. <code>'''edsh2'''</code>
::[[File:advancedmotionv1.png]]

== Time Based ==
*'''Happens At (with offset)'''
::This piston will execute at the specified time daily. Used an expression to fire this piston off 1 hour before sunset. <code>1citwt</code>
::[[File:happensat.png]]
*'''Time Between'''
::This piston will execute between the specified times. <code>x3pcd</code>
::[[File:timebetween.png]]

== Presence Tiles ==
*'''Presence Tiles'''
::Presence tiles piston, what i use myself. More on the piston in the piston comments.<code>v78tz</code>
::[[File:People_Presence_Tiles_Example_Piston.png]]

== Weather Tiles ==
*'''Weather Tiles'''
::The following two pistons show the weather forecast for the next few days & nights as well as the hourly forecast for the next 16 hours (conditions, chance of rain, temperature, and humidity). The background of the tiles changes based on average temperature (the colors and values for the coldest and warmest temperatures can be adjusted in the pistons - values between those two will be interpolated). The pistons can be easily changed to use °C instead of °F and use AM/PM rather the 24h time display by changing the respective boolean variables at the top of the piston.
::Here is what the tiles for those two pistons look like (during a somewhat boring forecast with not a lot of temperature variation):
::[[File:Weather_Tiles.png|800px|Sample display for weather tiles on webCORE dashboard]]
::Piston for the daily forecast tiles <code>gkws</code>
::[[File:Weather_Daily.png|800px|Daily forecast piston]]
::Piston for the hourly forecast tiles <code>s66j</code>
::[[File:Weather_Hourly.png|800px|Hourly forecast piston]]

== Misc ==
*'''Mirrored Switch'''
::This piston will mirror one switch to another. <code>1ai665</code>
::[[File:mirrorswitch.png]]
*'''Weather'''
::This piston will change the color of a bulb to blue if weather is below freezing. <code>hmfm5</code>
::[[File:weather.png]]

=Advanced Pistons = 
== [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar] ==
*'''House Scheduler'''
:This is one of two pistons that controls my home's mode and SHM. This is time based with presence as additional conditions. I currently have 7 modes for my house. Away - (Dawn/Day/Night), Home - (Dawn/Day/Night) and Sleep. As the day progresses the mode will change based on the time and presence of myself and/or girlfriend.<code>1hj33x</code>
::[[File:myschedule.png]]
*'''Magic Home'''
:This is one of two pistons that controls my home's mode and SHM. This piston works the opposite of the above in that the main driver of this piston is presence with time as additional conditions. When myself or my girlfriend get home, it checks to see who is arriving and which vehicle is missing for that person to determine which garage to open. After that it will assign the correct mode to the house and then send a push notification welcoming you home and letting you know that the garage is opening for you unless it is already open. Similarly when one of us leaves the house will give a goodbye message but if both of us are gone then it will alert the last person that all the lights have been turned off. <code>dyf6</code>
::[[File:Magichomev2.png]]

Samples

2017-10-26T16:24:09Z

Ahndee: /* Weather Tiles */

This is an ongoing library of examples so please let me know what else you would like to see on here. Please get a hold of [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar]  on the ST forums if you would like to see anything added to this page.

= Simple Pistons =
These are going to be pretty basic beginner level pistons.
== Motion Based ==
*'''Simple Motion Piston'''
: When the motion sensor changes to active, a light will turn on. <code>'''hsv3h'''</code>
::[[File:simplemotion.png]]
*'''Complex Motion Piston'''
::This piston will turn on a light with motion and off after 2 minutes of no motion. <code>'''p3rz7'''</code>
::[[File:complexmotionv2.png]]

== Motion Based EXCEPT When Manually Turned On ==
*'''Advanced Motion Piston'''
::This piston will turn on a light with motion and off after 5 minutes of no motion. But if user switches the light on it will not be turned off by motion, instead user will need to turn if off. If motion turned on the light and you want it to stay on till you turn it off, just switch the light off and on. The isBetween check sets the light level to 100% when between 4am to 11pm otherwise to 10% only when turned on by motion. note that while i use a light in this example it could be any device controlled by motion. <code>'''edsh2'''</code>
::[[File:advancedmotionv1.png]]

== Time Based ==
*'''Happens At (with offset)'''
::This piston will execute at the specified time daily. Used an expression to fire this piston off 1 hour before sunset. <code>1citwt</code>
::[[File:happensat.png]]
*'''Time Between'''
::This piston will execute between the specified times. <code>x3pcd</code>
::[[File:timebetween.png]]

== Presence Tiles ==
*'''Presence Tiles'''
::Presence tiles piston, what i use myself. More on the piston in the piston comments.<code>v78tz</code>
::[[File:People_Presence_Tiles_Example_Piston.png]]

== Weather Tiles ==
*'''Weather Tiles'''
::The following two pistons show the weather forecast for the next few days & nights as well as the hourly forecast for the next 16 hours (conditions, chance of rain, temperature, and humidity). The background of the tiles changes based on average temperature (the colors and values for the coldest and warmest temperatures can be adjusted in the pistons - values between those two will be interpolated). The pistons can be easily changed to use °C instead of °F and use AM/PM rather the 24h time display by changing the respective boolean variables at the top of the piston.
::Here is what the tiles for those two pistons look like (during a somewhat boring forecast with not a lot of temperature variation):
::[[File:Weather_Tiles.png|800px|Sample display for weather tiles on webCORE dashboard]]
::Piston for the daily forecast tiles <code>8zf6</code>
::[[File:Weather_Daily.png|800px|Daily forecast piston]]
::Piston for the hourly forecast tiles <code>nwbt</code>
::[[File:Weather_Hourly.png|800px|Hourly forecast piston]]

== Misc ==
*'''Mirrored Switch'''
::This piston will mirror one switch to another. <code>1ai665</code>
::[[File:mirrorswitch.png]]
*'''Weather'''
::This piston will change the color of a bulb to blue if weather is below freezing. <code>hmfm5</code>
::[[File:weather.png]]

=Advanced Pistons = 
== [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar] ==
*'''House Scheduler'''
:This is one of two pistons that controls my home's mode and SHM. This is time based with presence as additional conditions. I currently have 7 modes for my house. Away - (Dawn/Day/Night), Home - (Dawn/Day/Night) and Sleep. As the day progresses the mode will change based on the time and presence of myself and/or girlfriend.<code>1hj33x</code>
::[[File:myschedule.png]]
*'''Magic Home'''
:This is one of two pistons that controls my home's mode and SHM. This piston works the opposite of the above in that the main driver of this piston is presence with time as additional conditions. When myself or my girlfriend get home, it checks to see who is arriving and which vehicle is missing for that person to determine which garage to open. After that it will assign the correct mode to the house and then send a push notification welcoming you home and letting you know that the garage is opening for you unless it is already open. Similarly when one of us leaves the house will give a goodbye message but if both of us are gone then it will alert the last person that all the lights have been turned off. <code>dyf6</code>
::[[File:Magichomev2.png]]

File:Weather Tiles.png

2017-10-26T16:21:18Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-10-24T15:49:20Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-10-24T15:48:20Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-10-24T15:47:17Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-08-03T15:32:34Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

Samples

2017-08-02T21:01:19Z

Ahndee:

This is an ongoing library of examples so please let me know what else you would like to see on here. Please get a hold of [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar]  on the ST forums if you would like to see anything added to this page.

= Simple Pistons =
These are going to be pretty basic beginner level pistons.
== Motion Based ==
*'''Simple Motion Piston'''
: When the motion sensor changes to active, a light will turn on. <code>'''hsv3h'''</code>
::[[File:simplemotion.png]]
*'''Complex Motion Piston'''
::This piston will turn on a light with motion and off after 2 minutes of no motion. <code>'''p3rz7'''</code>
::[[File:complexmotionv2.png]]

== Motion Based EXCEPT When Manually Turned On ==
*'''Advanced Motion Piston'''
::This piston will turn on a light with motion and off after 5 minutes of no motion. But if user switches the light on it will not be turned off by motion, instead user will need to turn if off. If motion turned on the light and you want it to stay on till you turn it off, just switch the light off and on. The isBetween check sets the light level to 100% when between 4am to 11pm otherwise to 10% only when turned on by motion. note that while i use a light in this example it could be any device controlled by motion. <code>'''edsh2'''</code>
::[[File:advancedmotionv1.png]]

== Time Based ==
*'''Happens At (with offset)'''
::This piston will execute at the specified time daily. Used an expression to fire this piston off 1 hour before sunset. <code>1citwt</code>
::[[File:happensat.png]]
*'''Time Between'''
::This piston will execute between the specified times. <code>x3pcd</code>
::[[File:timebetween.png]]

== Presence Tiles ==
*'''Presence Tiles'''
::Presence tiles piston, what i use myself. More on the piston in the piston comments.<code>v78tz</code>
::[[File:People_Presence_Tiles_Example_Piston.png]]

== Weather Tiles ==
*'''Weather Tiles'''
::The following two pistons show the weather forecast for the next few days & nights as well as the hourly forecast for the next 16 hours (conditions, temperature, and humidity). The background of the tiles changes based on average temperature (the colors and values for the coldest and warmest temperatures can be adjusted in the pistons - values between those two will be interpolated). The pistons can be easily changed to use °C instead of °F and use AM/PM rather the 24h time display by changing the respective boolean variables at the top of the piston.
::Here is what the tiles for those two pistons look like (during a somewhat boring forecast with not a lot of temperature variation):
::[[File:Weather_Tiles.png|800px|Sample display for weather tiles on webCORE dashboard]]
::Piston for the daily forecast tiles <code>8zf6</code>
::[[File:Weather_Daily.png|800px|Daily forecast piston]]
::Piston for the hourly forecast tiles <code>nwbt</code>
::[[File:Weather_Hourly.png|800px|Hourly forecast piston]]

== Misc ==
*'''Mirrored Switch'''
::This piston will mirror one switch to another. <code>1ai665</code>
::[[File:mirrorswitch.png]]
*'''Weather'''
::This piston will change the color of a bulb to blue if weather is below freezing. <code>hmfm5</code>
::[[File:weather.png]]

=Advanced Pistons = 
== [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar] ==
*'''House Scheduler'''
:This is one of two pistons that controls my home's mode and SHM. This is time based with presence as additional conditions. I currently have 7 modes for my house. Away - (Dawn/Day/Night), Home - (Dawn/Day/Night) and Sleep. As the day progresses the mode will change based on the time and presence of myself and/or girlfriend.<code>1hj33x</code>
::[[File:myschedule.png]]
*'''Magic Home'''
:This is one of two pistons that controls my home's mode and SHM. This piston works the opposite of the above in that the main driver of this piston is presence with time as additional conditions. When myself or my girlfriend get home, it checks to see who is arriving and which vehicle is missing for that person to determine which garage to open. After that it will assign the correct mode to the house and then send a push notification welcoming you home and letting you know that the garage is opening for you unless it is already open. Similarly when one of us leaves the house will give a goodbye message but if both of us are gone then it will alert the last person that all the lights have been turned off. <code>9ev6l</code>
::[[File:magichome.png]]

File:Weather Tiles.png

2017-08-02T15:51:17Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-08-02T15:44:15Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

File:Weather Tiles.png

2017-08-02T15:43:22Z

Ahndee: Ahndee uploaded a new version of File:Weather Tiles.png

Samples

2017-07-29T05:19:32Z

Ahndee: /* Weather Tiles */

This is an ongoing library of examples so please let me know what else you would like to see on here. Please get a hold of [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar]  on the ST forums if you would like to see anything added to this page.

= Simple Pistons =
These are going to be pretty basic beginner level pistons.
== Motion Based ==
*'''Simple Motion Piston'''
: When the motion sensor changes to active, a light will turn on. <code>'''hsv3h'''</code>
::[[File:simplemotion.png]]
*'''Complex Motion Piston'''
::This piston will turn on a light with motion and off after 2 minutes of no motion. <code>'''p3rz7'''</code>
::[[File:complexmotionv2.png]]
*'''Advanced Motion Piston'''
::This piston will turn on a light with motion and off after 5 minutes of no motion. But if user switches the light on it will not be turned off by motion, instead user will need to turn if off. If motion turned on the light and you want it to stay on till you turn it off, just switch the light off and on. The isBetween check sets the light level to 100% when between 4am to 11pm otherwise to 10% only when turned on by motion. note that while i use a light in this example it could be any device controlled by motion. <code>'''edsh2'''</code>
::[[File:advancedmotionv1.png]]

== Time Based ==
*'''Happens At (with offset)'''
::This piston will execute at the specified time daily. Used an expression to fire this piston off 1 hour before sunset. <code>1citwt</code>
::[[File:happensat.png]]
*'''Time Between'''
::This piston will execute between the specified times. <code>x3pcd</code>
::[[File:timebetween.png]]

== Presence Tiles ==
*'''Presence Tiles'''
::Presence tiles piston, what i use myself. More on the piston in the piston comments.<code>v78tz</code>
::[[File:People_Presence_Tiles_Example_Piston.png]]

== Weather Tiles ==
*'''Weather Tiles'''
::The following two pistons show the weather forecast for the next few days & nights as well as the hourly forecast for the next 16 hours (conditions, temperature, and humidity). The background of the tiles changes based on average temperature (the colors and values for the coldest and warmest temperatures can be adjusted in the pistons - values between those two will be interpolated). The pistons can be easily changed to use °C instead of °F and use AM/PM rather the 24h time display by changing the respective boolean variables at the top of the piston.
::Here is what the tiles for those two pistons look like (during a somewhat boring forecast with not a lot of temperature variation):
::[[File:Weather_Tiles.png|800px]]
::Piston for the daily forecast tiles <code>8zf6</code>
::[[File:Weather_Daily.png|800px]]
::Piston for the hourly forecast tiles <code>nwbt</code>
::[[File:Weather_Hourly.png|800px]]

== Misc ==
*'''Mirrored Switch'''
::This piston will mirror one switch to another. <code>1ai665</code>
::[[File:mirrorswitch.png]]
*'''Weather'''
::This piston will change the color of a bulb to blue if weather is below freezing. <code>hmfm5</code>
::[[File:weather.png]]

=Advanced Pistons = 
== [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar] ==
*'''House Scheduler'''
:This is one of two pistons that controls my home's mode and SHM. This is time based with presence as additional conditions. I currently have 7 modes for my house. Away - (Dawn/Day/Night), Home - (Dawn/Day/Night) and Sleep. As the day progresses the mode will change based on the time and presence of myself and/or girlfriend.<code>1hj33x</code>
::[[File:myschedule.png]]
*'''Magic Home'''
:This is one of two pistons that controls my home's mode and SHM. This piston works the opposite of the above in that the main driver of this piston is presence with time as additional conditions. When myself or my girlfriend get home, it checks to see who is arriving and which vehicle is missing for that person to determine which garage to open. After that it will assign the correct mode to the house and then send a push notification welcoming you home and letting you know that the garage is opening for you unless it is already open. Similarly when one of us leaves the house will give a goodbye message but if both of us are gone then it will alert the last person that all the lights have been turned off. <code>9ev6l</code>
::[[File:magichome.png]]

File:Weather Hourly.png

2017-07-29T05:10:10Z

Ahndee:

File:Weather Daily.png

2017-07-29T05:09:54Z

Ahndee:

File:Weather Tiles.png

2017-07-29T05:09:36Z

Ahndee:

Samples

2017-07-29T05:08:59Z

Ahndee: /* Simple Pistons */

This is an ongoing library of examples so please let me know what else you would like to see on here. Please get a hold of [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar]  on the ST forums if you would like to see anything added to this page.

= Simple Pistons =
These are going to be pretty basic beginner level pistons.
== Motion Based ==
*'''Simple Motion Piston'''
: When the motion sensor changes to active, a light will turn on. <code>'''hsv3h'''</code>
::[[File:simplemotion.png]]
*'''Complex Motion Piston'''
::This piston will turn on a light with motion and off after 2 minutes of no motion. <code>'''p3rz7'''</code>
::[[File:complexmotionv2.png]]
*'''Advanced Motion Piston'''
::This piston will turn on a light with motion and off after 5 minutes of no motion. But if user switches the light on it will not be turned off by motion, instead user will need to turn if off. If motion turned on the light and you want it to stay on till you turn it off, just switch the light off and on. The isBetween check sets the light level to 100% when between 4am to 11pm otherwise to 10% only when turned on by motion. note that while i use a light in this example it could be any device controlled by motion. <code>'''edsh2'''</code>
::[[File:advancedmotionv1.png]]

== Time Based ==
*'''Happens At (with offset)'''
::This piston will execute at the specified time daily. Used an expression to fire this piston off 1 hour before sunset. <code>1citwt</code>
::[[File:happensat.png]]
*'''Time Between'''
::This piston will execute between the specified times. <code>x3pcd</code>
::[[File:timebetween.png]]

== Presence Tiles ==
*'''Presence Tiles'''
::Presence tiles piston, what i use myself. More on the piston in the piston comments.<code>v78tz</code>
::[[File:People_Presence_Tiles_Example_Piston.png]]

== Weather Tiles ==
*'''Weather Tiles'''
::The following two pistons show the weather forecast for the next few days & nights as well as the hourly forecast for the next 16 hours. The background of the tiles changes based on average temperature (the colors and values for the coldest and warmest temperatures can be adjusted in the pistons - values between those two will be interpolated)
::Here is what the tiles for those two pistons look like (during a somewhat boring forecast with not a lot of temperature variation):

== Misc ==
*'''Mirrored Switch'''
::This piston will mirror one switch to another. <code>1ai665</code>
::[[File:mirrorswitch.png]]
*'''Weather'''
::This piston will change the color of a bulb to blue if weather is below freezing. <code>hmfm5</code>
::[[File:weather.png]]

=Advanced Pistons = 
== [https://community.smartthings.com/users/c1arkbar/activity @c1arkbar] ==
*'''House Scheduler'''
:This is one of two pistons that controls my home's mode and SHM. This is time based with presence as additional conditions. I currently have 7 modes for my house. Away - (Dawn/Day/Night), Home - (Dawn/Day/Night) and Sleep. As the day progresses the mode will change based on the time and presence of myself and/or girlfriend.<code>1hj33x</code>
::[[File:myschedule.png]]
*'''Magic Home'''
:This is one of two pistons that controls my home's mode and SHM. This piston works the opposite of the above in that the main driver of this piston is presence with time as additional conditions. When myself or my girlfriend get home, it checks to see who is arriving and which vehicle is missing for that person to determine which garage to open. After that it will assign the correct mode to the house and then send a push notification welcoming you home and letting you know that the garage is opening for you unless it is already open. Similarly when one of us leaves the house will give a goodbye message but if both of us are gone then it will alert the last person that all the lights have been turned off. <code>9ev6l</code>
::[[File:magichome.png]]

Functions

2017-07-17T20:23:22Z

Ahndee: /* abs */

<div style="float: left; clear: both; margin-right: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
[[File:Format.pdf|page=1|thumb|256px|A very nice article written by Professor Don Colton, at the Brigham Young University of Hawaii]]
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==random==
:Syntax
::<code>''dynamic'' random([''integer'' range | ''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN]])</code>
:Arguments
::<code>range</code> - an integer number representing a range
::<code>value1</code>..<code>valueN</code> - any kind of arguments, one will be randomly returned
:Returns
::Returns a random decimal number between <code>0</code> and <code>1</code> if no arguments are provided, or a number between <code>0</code> and <code>range</code> (inclusive) if a single argument is provided, or a randomly selected argument if two or more arguments are provided.
:Examples
::<code>random()</code> outputs <code>0.483</code> (random decimal)
::<code>random(20)</code> outputs <code>6</code> (random integer)
::<code>random("Hello World", "Good morning", "Hello", "Hi")</code> outputs <code>Hello</code> (randomly selected value)
:Tips
::To output a random integer between 5 and 20 use <code>(5 + random(15))</code>
::To output a random integer between -5 and 20 use <code>(-5 + random(25))</code>

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>upper("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

==trim==
:Syntax
::<code>"string" trim("string" value)</code>
:Returns
::Returns the <code>value</code> with leading and trailing spaces removed
:Examples
::<code>trim(" Hello World ")</code> outputs <code>Hello World</code>

==trimLeft==
:Syntax
::<code>"string" trimLeft("string" value)</code>
:Returns
::Returns the <code>value</code> with leading spaces removed
:Examples
::<code>trimLeft(" Hello World ")</code> outputs <code>"Hello World "</code>

==ltrim==
:Alias of <code>trimLeft()</code>

==trimRight==
:Syntax
::<code>"string" trimRight("string" value)</code>
:Returns
::Returns the <code>value</code> with trailing spaces removed
:Examples
::<code>trimRight(" Hello World ")</code> outputs <code>" Hello World"</code>

==rtrim==
:Alias of <code>trimRight()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==abs==
:Syntax
::<code>''decimal'' abs(''decimal'' value)</code>
:Returns
::Returns the absolute value of the argument (e.g., remove negative sign for negative values).

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device﹕attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device﹕attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

Functions

2017-07-17T20:23:08Z

Ahndee: Add abs(value)

<div style="float: left; clear: both; margin-right: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
[[File:Format.pdf|page=1|thumb|256px|A very nice article written by Professor Don Colton, at the Brigham Young University of Hawaii]]
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==random==
:Syntax
::<code>''dynamic'' random([''integer'' range | ''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN]])</code>
:Arguments
::<code>range</code> - an integer number representing a range
::<code>value1</code>..<code>valueN</code> - any kind of arguments, one will be randomly returned
:Returns
::Returns a random decimal number between <code>0</code> and <code>1</code> if no arguments are provided, or a number between <code>0</code> and <code>range</code> (inclusive) if a single argument is provided, or a randomly selected argument if two or more arguments are provided.
:Examples
::<code>random()</code> outputs <code>0.483</code> (random decimal)
::<code>random(20)</code> outputs <code>6</code> (random integer)
::<code>random("Hello World", "Good morning", "Hello", "Hi")</code> outputs <code>Hello</code> (randomly selected value)
:Tips
::To output a random integer between 5 and 20 use <code>(5 + random(15))</code>
::To output a random integer between -5 and 20 use <code>(-5 + random(25))</code>

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>upper("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

==trim==
:Syntax
::<code>"string" trim("string" value)</code>
:Returns
::Returns the <code>value</code> with leading and trailing spaces removed
:Examples
::<code>trim(" Hello World ")</code> outputs <code>Hello World</code>

==trimLeft==
:Syntax
::<code>"string" trimLeft("string" value)</code>
:Returns
::Returns the <code>value</code> with leading spaces removed
:Examples
::<code>trimLeft(" Hello World ")</code> outputs <code>"Hello World "</code>

==ltrim==
:Alias of <code>trimLeft()</code>

==trimRight==
:Syntax
::<code>"string" trimRight("string" value)</code>
:Returns
::Returns the <code>value</code> with trailing spaces removed
:Examples
::<code>trimRight(" Hello World ")</code> outputs <code>" Hello World"</code>

==rtrim==
:Alias of <code>trimRight()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==abs==
:Syntax
::<code>''decimal'' abs(''decimal'' value])</code>
:Returns
::Returns the absolute value of the argument (e.g., remove negative sign for negative values).

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device﹕attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device﹕attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

Functions

2017-06-28T04:38:22Z

Ahndee: Add newly supported trim/trimLeft/ltrim/trimRight/rtrim functions

<div style="float: left; clear: both; margin-right: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
[[File:Format.pdf|page=1|thumb|256px|A very nice article written by Professor Don Colton, at the Brigham Young University of Hawaii]]
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==random==
:Syntax
::<code>''dynamic'' random([''integer'' range | ''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN]])</code>
:Arguments
::<code>range</code> - an integer number representing a range
::<code>value1</code>..<code>valueN</code> - any kind of arguments, one will be randomly returned
:Returns
::Returns a random decimal number between <code>0</code> and <code>1</code> if no arguments are provided, or a number between <code>0</code> and <code>range</code> (inclusive) if a single argument is provided, or a randomly selected argument if two or more arguments are provided.
:Examples
::<code>random()</code> outputs <code>0.483</code> (random decimal)
::<code>random(20)</code> outputs <code>6</code> (random integer)
::<code>random("Hello World", "Good morning", "Hello", "Hi")</code> outputs <code>Hello</code> (randomly selected value)
:Tips
::To output a random integer between 5 and 20 use <code>(5 + random(15))</code>
::To output a random integer between -5 and 20 use <code>(-5 + random(25))</code>

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>upper("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

==trim==
:Syntax
::<code>"string" trim("string" value)</code>
:Returns
::Returns the <code>value</code> with leading and trailing spaces removed
:Examples
::<code>trim(" Hello World ")</code> outputs <code>Hello World</code>

==trimLeft==
:Syntax
::<code>"string" trimLeft("string" value)</code>
:Returns
::Returns the <code>value</code> with leading spaces removed
:Examples
::<code>trimLeft(" Hello World ")</code> outputs <code>"Hello World "</code>

==ltrim==
:Alias of <code>trimLeft()</code>

==trimRight==
:Syntax
::<code>"string" trimRight("string" value)</code>
:Returns
::Returns the <code>value</code> with trailing spaces removed
:Examples
::<code>trimRight(" Hello World ")</code> outputs <code>" Hello World"</code>

==rtrim==
:Alias of <code>trimRight()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device﹕attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device﹕attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

User talk:Ahndee

2017-05-16T05:20:29Z

Ahndee: Blanked the page

Functions

2017-05-07T23:53:17Z

Ahndee: /* Integers */

<div style="float: right; clear: both; margin-left: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==random==
:Syntax
::<code>''dynamic'' random([''integer'' range | ''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN]])</code>
:Arguments
::<code>range</code> - an integer number representing a range
::<code>value1</code>..<code>valueN</code> - any kind of arguments, one will be randomly returned
:Returns
::Returns a random decimal number between <code>0</code> and <code>1</code> if no arguments are provided, or a number between <code>0</code> and <code>range</code> (inclusive) if a single argument is provided, or a randomly selected argument if two or more arguments are provided.
:Examples
::<code>random()</code> outputs <code>0.483</code> (random decimal)
::<code>random(20)</code> outputs <code>6</code> (random integer)
::<code>random("Hello World", "Good morning", "Hello", "Hi")</code> outputs <code>Hello</code> (randomly selected value)

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device﹕attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device﹕attribute],[...], [device﹕attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device﹕attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

Functions

2017-05-07T23:49:08Z

Ahndee: /* Integers */

<div style="float: right; clear: both; margin-left: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==random==
:Syntax
::<code>''dynamic'' random([''integer'' range | ''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN]])</code>
:Arguments
::<code>range</code> - an integer number representing a range
::<code>value1</code>..<code>valueN</code> - any kind of arguments, one will be randomly returned
:Returns
::Returns a random decimal number between <code>0</code> and <code>1</code> if no arguments are provided, or a number between <code>0</code> and <code>range</code> (inclusive) if a single argument is provided, or a randomly selected argument if two or more arguments are provided.
:Examples
::<code>random()</code> outputs <code>0.483</code> (random decimal)
::<code>random(20)</code> outputs <code>6</code> (random integer)
::<code>random("Hello World", "Good morning", "Hello", "Hi")</code> outputs <code>Hello</code> (randomly selected value)

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device:attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device:attribute],[...], [device:attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device:attribute],[...], [device:attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device:attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

User:Ahndee

2017-05-06T22:20:02Z

Ahndee:

SmartThings app slinger - see https://github.com/ahndee/Envoy-ST for my custom solar monitoring DTHs for Enphase Envoy and SolarEdge.

https://gvconnect.com

http://andreasamann.com

Functions

2017-05-06T18:42:33Z

Ahndee: Fix descriptions for ceil & floor, adding examples

<div style="float: right; clear: both; margin-left: 1em; margin-bottom: 1em;">__TOC__</div>
Functions are extensions to expressions that allow data processing and conversion. Here is a list of all defined functions

=[[Variable_data_types#String|String]] functions=

==concat==
:Syntax
::<code>''string'' concat(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns a string that is the concatenation of all the supplied values. This function accepts two or more input values.

==contains==
:Syntax
::<code>''boolean'' contains(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if the <code>needle</code> is found anywhere in the <code>haystack</code>

==endsWith==
:Syntax
::<code>''boolean'' endsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> ends with the <code>needle</code>

==format==
:Syntax
::<code>''string'' format(''string'' formatString[, ''dynamic'' value1[, .., ''dynamic'' valueN]])</code>
:Returns
::Returns a string that is built based on the <code>formatString</code> with arguments replaced by their corresponding values. Follows the java syntax for <code>printf()</code>. See a quick reference [https://www.cs.colostate.edu/~cs160/.Summer16/resources/Java_printf_method_quick_reference.pdf here], or a more detailed reference [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference here].
::Each % in the format string represents an argument and corresponds to a value (in order of appearance) in the value list. Each argument can have formatting settings, according to the reference provided.
:Example
::<code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>
::The <code>%.2f</code> translates to "format as <code>f</code>loat and use <code>.2</code> decimal places.

==indexOf==
:Syntax
::<code>''integer'' indexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the first occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>indexOf("hello world", 'l')</code> outputs <code>2</code>

==lastIndexOf==
:Syntax
::<code>''integer'' lastIndexOf(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns the character index of the last occurrence of <code>needle</code> inside <code>haystack</code>
:Examples
::<code>lastIndexOf("hello world", 'l')</code> outputs <code>9</code>

==left==
:Syntax
::<code>''string'' left(''string'' value, ''integer'' length)</code>
:Returns
::Returns the first <code>length</code> characters in <code>value</code>
:Examples
::<code>left("hello world", 2)</code> outputs <code>he</code>

==lower==
:Syntax
::<code>''string'' lower(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all lower case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>hello world</code>

==mid==
:Syntax
::<code>''string'' mid(''string'' value, ''integer'' start[, ''integer'' count = remaining])</code>
:Arguments
::<code>start</code> - provides the 0-based index of the first character to copy. If <code>start</code> is negative, the counting starts from the end of <code>value</code>.
::<code>count</code> - provides the number of characters to copy from <code>value</code>. If not provided, all of the remaining characters from <code>value</code> are returned, starting with character number <code>start</code>. If <code>count</code> is negative, prior characters are returned.
:Returns
::Returns a substring of <code>value</code>, <code>count</code> characters long, starting at character number <code>start</code>. Note that the first character in any string has index 0.
:Examples
::<code>mid("Hello World", 2, 3)</code> outputs <code>llo</code>
::<code>mid("Hello World", 2)</code> outputs <code>llo World</code>
::<code>mid("Hello World", -5, 2)</code> outputs <code>Wo</code>
::<code>mid("Hello World", -1, -3)</code> outputs <code>orl</code>

==replace==
:Syntax
::<code>''string'' replace(''string'' haystack, ''string'' needle1, ''string'' replacement1[, .., ''string'' needleN, ''string'' replacementN])</code>
:Returns
::Replaces all the occurrences of <code>needle</code> inside <code>haystack</code> with its respective <code>replacement</code>. Multiple pairs of <code>needle</code>/<code>replacement</code> can be provided in one function call.
:Regular expressions
::Needles support regular expressions when their value starts and ends with a <code>/</code>. For example, <code>'/(\s)/'</code> will match all spaces.
:Examples
::<code>replace("Hello World", 'World', 'Earth')</code> outputs <code>Hello Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Hello', 'Hi')</code> outputs <code>Hi Earth</code>
::<code>replace("Hello World", 'World', 'Earth', 'Earth', 'Planet')</code> outputs <code>Hello Planet</code>

==right==
:Syntax
::<code>''string'' right(''string'' value, ''integer'' length)</code>
:Returns
::Returns the last <code>length</code> characters in <code>value</code>
:Examples
::<code>right("hello world", 4)</code> outputs <code>orld</code>

==startsWith==
:Syntax
::<code>''boolean'' startsWith(''string'' haystack, ''string'' needle)</code>
:Returns
::Returns true if <code>haystack</code> starts with the <code>needle</code>

==string==
:Syntax
::<code>''string'' string(''dynamic'' value)</code>
:Returns
::Returns <code>value</code> as a string.

==substr==
:Alias of <code>mid()</code>

==substring==
:Alias of <code>mid()</code>

==title==
:Syntax
::<code>''string'' title(''string'' value)</code>
:Returns
::Returns the <code>value</code> but in its title case format (each word starts with a capitalized letter).
:Examples
::<code>lower("Hello there world")</code> outputs <code>Hello There World</code>

==upper==
:Syntax
::<code>''string'' upper(''string'' value)</code>
:Returns
::Returns the <code>value</code> but with all upper case letters.
:Examples
::<code>lower("Hello World")</code> outputs <code>HELLO WORLD</code>

==text==
:Alias of <code>string()</code>

=Numeric functions=

==avg==
:Syntax
::<code>''decimal'' avg(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the mean average of all the values provided.

==ceil==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the immediately higher integer, equivalent to rounding the decimal away from zero.
:Examples
::<code>ceil(5.6)</code> outputs <code>6</code>
::<code>ceil(-5.6)</code> outputs <code>-6</code>

==ceiling==
:Alias of <code>ceil</code>

==decimal==
:Syntax
::<code>''decimal'' decimal(''dynamic'' value)</code>
:Returns
::Converts <code>value</code> into a decimal. Returns <code>0</code> if <code>value</code> is not numeric.

==float==
:Alias of <code>decimal</code>

==floor==
:Syntax
::<code>''integer'' ceil(''decimal'' value)</code>
:Returns
::Returns the integer part of a decimal, equivalent to rounding the decimal towards zero.
:Examples
::<code>floor(5.6)</code> outputs <code>5</code>
::<code>floor(-5.6)</code> outputs <code>-5</code>

==max==
:Syntax
::<code>''dynamic'' max(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the maximum of all the values provided. Note: this function works with both numbers and strings.

==median==
:Syntax
::<code>''dynamic'' median(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the median average of all the values provided. Note: this function works with both numbers and strings.

==min==
:Syntax
::<code>''dynamic'' min(''dynamic'' value1, ''dynamic'' value2[, .., ''dynamic'' valueN])</code>
:Returns
::Returns the minimum of all the values provided. Note: this function works with both numbers and strings.

==number==
:Alias of <code>decimal</code>

==power==
:Syntax
::<code>''decimal'' power(''decimal'' value, ''decimal'' exponent)</code>
:Returns
::Returns the <code>value</code> at the power of <code>exponent</code>

==round==
:Syntax
::<code>''decimal'' round(''decimal'' value[, ''integer'' precision = 0])</code>
:Arguments
::<code>precision</code> - the number of decimal places to be retained. If not provided, defaults to <code>0</code>
:Returns
::Returns the rounded <code>value</code> with <code>precision</code> decimal places.

==sqr==
:Syntax
::<code>''decimal'' sqr(''decimal'' value)</code>
:Returns
::Returns the squared <code>value</code>, equivalent to <code>value</code> multiplied by itself.

==sqrt==
:Syntax
::<code>''decimal'' sqrt(''decimal'' value)</code>
:Returns
::Returns the square root of <code>value</code>.

==stdev==
:Syntax
::<code>''decimal'' stdev(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the standard deviation of all the values provided.

==sum==
:Syntax
::<code>''decimal'' sum(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the sum of sum of all the values provided.

==variance==
:Syntax
::<code>''decimal'' variance(''decimal'' value1, ''decimal'' value2[, .., ''decimal'' valueN])</code>
:Returns
::Returns the variance of all the values provided.

=[[Variable_data_types#Boolean|Boolean]] functions=

==bool==
:Syntax
::<code>bool(''dynamic'' value)</code>
:Returns
::Returns the truth value of the input. Accepts anything as input and will return true if <code>value</code> is either a non-zero number, a non-empty string (with some exceptions, see below), a non-empty device list, a non-empty date/time/datetime

==boolean==
:This is an alias of [[Functions#bool|bool]]

==eq==
:Syntax
::<code>eq(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is equivalent to <code>value2</code>

==ge==
:Syntax
::<code>ge(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than or equal to <code>value2</code>

==gt==
:Syntax
::<code>gt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is greater than <code>value2</code>

==isBetween==
:Syntax
::<code>isBetween(''dynamic'' value, ''dynamic'' startValue, ''dynamic'' endValue)</code>
:Returns
::Returns true if <code>value</code> is greater then or equal to <code>startValue</code> and less than or equal to <code>endValue</code>

==isEmpty==
:Syntax
::<code>isEmpty(''dynamic'' value)</code>
:Returns
::Returns true if <code>value</code> is not set, an empty string, or zero

==le==
:Syntax
::<code>le(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than or equal to <code>value2</code>

==lt==
:Syntax
::<code>lt(''dynamic'' value1, ''dynamic'' value2)</code>
:Returns
::Returns true if <code>value1</code> is less than <code>value2</code>

==not==
:Syntax
::<code>not(''dynamic'' value)</code>
:Returns
::Returns the negated truth state of <code>value</code>. This is the logical negation of <code>[[Functions#bool|bool]](''dynamic'' value)</code>.

=[[Variable_data_types#Date_and_Time|Date and time]] functions=

==addDays==
:Syntax
::<code>addDays(''datetime'' value, ''integer'' days)</code>
:Returns
::Returns a datetime that is <code>days</code> days after the <code>value</code>. For negative values of <code>days</code>, it returns a datetime that is <code>days</code> days before <code>value</code>.

==addHours==
:Syntax
::<code>addHours(''datetime'' value, ''integer'' hours)</code>
:Returns
::Returns a datetime that is <code>hours</code> hours after the <code>value</code>. For negative values of <code>hours</code>, it returns a datetime that is <code>hours</code> hours before <code>value</code>.

==addMinutes==
:Syntax
::<code>addMinutes(''datetime'' value, ''integer'' minutes)</code>
:Returns
::Returns a datetime that is <code>minutes</code> minutes after the <code>value</code>. For negative values of <code>minutes</code>, it returns a datetime that is <code>minutes</code> minutes before <code>value</code>.

==addSeconds==
:Syntax
::<code>addSeconds(''datetime'' value, ''integer'' seconds)</code>
:Returns
::Returns a datetime that is <code>seconds</code> seconds after the <code>value</code>. For negative values of <code>seconds</code>, it returns a datetime that is <code>seconds</code> seconds before <code>value</code>.

==addWeeks==
:Syntax
::<code>addWeeks(''datetime'' value, ''integer'' weeks)</code>
:Returns
::Returns a datetime that is <code>weeks</code> weeks after the <code>value</code>. For negative values of <code>weeks</code>, it returns a datetime that is <code>weeks</code> weeks before <code>value</code>.

==date==
:Syntax
::<code>date(''datetime'' value)</code>
:Returns
::Returns the date portion of <code>value</code> by stripping off time information.

==datetime==
:Syntax
::<code>''datetime'' datetime(''dynamic'' value)</code>
:Returns
::Tries to convert any value into a datetime. Accepts strings in common date/time formats.

==formatDuration==
:Syntax
::<code>''string'' formatDuration(''datetime'' value[, ''boolean'' friendly = false[, ''string'' granularity = 's'[, ''boolean'' showAdverbs = false]]])</code>
:Arguments
::<code>friendly</code> - <code>false</code> makes the output compact, in the form of <code>0d 00:00:00.000</code>, while <code>true</code> makes the output more human friendly, in the form of <code> 0 days, 0 hours, 0 minutes, and 0 seconds</code>. Defaults to <code>false</code>.
::<code>granularity</code> - represents the smallest time unit to be output. One of <code>d</code> for days, <code>h</code> for hours, <code>m</code> for minutes, <code>s</code> for seconds, or <code>ms</code> for milliseconds. Any time unit below the selected granularity will not be output. Defaults to <code>s</code>
::<code>showAdverbs</code> - only affects the friendly output, when <code>true</code> the words <code>in</code> (for future durations - positive input) or <code>ago</code> (for past durations - negative input) are prepended or appended respectively to the output
:Returns
::Returns a string that represents the duration in a human readable format
:Examples
::<code>formatDuration(12029)</code> will output <code>00:00:12</code>
::<code>formatDuration(68493, true)</code> will output <code>1 minute and 8 seconds</code>
::<code>formatDuration(68493, false, 'ms')</code> will output <code>00:01:08</code>
::<code>formatDuration(68493, true, 'm', true)</code> will output <code>in 1 minute</code>

==time==
:Syntax
::<code>''time'' time(''datetime'' value)</code>
:Returns
::Returns the time portion of <code>value</code> by stripping off date information.

=Weather related functions=

==celsius==
:Syntax
::<code>''decimal'' celsius(''decimal'' value)</code>
:Returns
::Converts a temperature value from Fahrenheit to Celsius.

==dewPoint==
:Syntax
::<code>''decimal'' dewPoint(''decimal'' temperature, ''decimal'' relativeHumidity[, ''string'' scale = 'F'])</code>
:Parameters
::<code>scale</code> - optional, one of <code>C</code> or <code>F</code>, corresponding to the temperature range used for <code>temperature</code>. The result will be provided in the same scale. If no scale is provided, the Fahrenheit scale will be used.
:Returns
::Returns the due temperature for a given temperature and relative humidity

==fahrenheit==
:Syntax
::<code>''decimal'' fahrenheit(''decimal'' value)</code>
:Returns
::Converts a temperature value from Celsius to Fahrenheit.

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device;attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device;attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

Functions

2017-05-05T22:20:10Z

Ahndee: Correct return time for add…() Datetime functions

= [[Variable_data_types#Boolean|Boolean]] =
;bool()
://todo
;boolean(anything)
:converts a value to it's boolean value
;contains(string, substring)
:returns true if a string contains a substring
;endsWith(string, substring)
:returns true if a string ends with a substring
;eq(value1, value2)
:returns true if two values are equal
;ge(value1, value2)
:returns true if value1 >= value2
;gt(value1, value2)
:returns true if value1 > value2
;isBetween(value, startValue, endValue)
:returns true if value >= startValue and value <= endValue
;isEmpty(value)
:returns true if the value is empty
;le(value1, value2)
:returns true if value1 <= value2
;lt(value1, value2)
:returns true if value1 < value2
;not(value)
:returns the negative boolean value
;startsWith(string, substring)
:returns true if a string starts with a substring

= [[Variable_data_types#Date|Date]] =
;date(value)
:returns the value as a date type

= [[Variable_data_types#Date_and_Time|Datetime]] =
;addDays(dateTime, days)
:returns the value as a Datetime type
;addHours(dateTime, hours)
:returns the value as a Datetime type
;addMinutes(dateTime, minutes)
:returns the value as a Datetime type
;addSeconds(dateTime, seconds)
:returns the value as a Datetime type
;addWeeks(dateTime, weeks)
:returns the value as a Datetime type

= [[Variable_data_types#Number_.28Decimal.29|Decimal]] =
;avg(values)
:calculates the average of a series of numeric values
;ceil()
://todo
;ceiling(decimal or string)
:converts a decimal value to it's closest higher integer value
;celsius(temperature)
:converts temperature from Fahrenheit to Celsius
;decimal(integer or string)
:converts an integer value to it's decimal value
;dewPoint(temperature, relativeHumidity[, scale])
:returns the calculated dew point temperature
;fahrenheit([Sensor;temperature])
:converts temperature from Celsius to Fahrenheit
;float()
://todo
;floor(decimal or string)
:converts a decimal value to it's closest lower integer value
;max(values)
:calculates the maximum of a series of numeric values
;median(values)
:returns the value in the middle of a sorted array
;min(values)
:calculates the minimum of a series of numeric values
;number()
://todo
;power(integer or decimal or string, power)
:converts a decimal value to it's power decimal value
;round(decimal or string, [precision])
:converts a decimal value to it's rounded value
;sqr(integer or decimal or string)
:converts a decimal value to it's square decimal value
;sqrt(integer or decimal or string)
:converts a decimal value to it's square root decimal value
;stdev(values)
:calculates the standard deviation of a series of numeric values
;sum(values)
:calculates the sum of a series of numeric values
;variance(values)
:calculates the standard deviation of a series of numeric values

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device;attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device;attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#String|String]] =
;concat(string1, string2)
:returns two strings appended together
: Example: <code>concat("hello ", "world")</code> or <code>concat("hello", " ", "world")</code> outputs <code>hello world</code>

;format(format string, values)
:Usage:
::formatString is a Java printf() type format string (see [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference])
::values is a dynamic length list of values (one entry for each % in the format string)
:returns a string with the placeholders replaced with the appropriately formatted values
: Example: <code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>

;formatDuration(value[, friendly = false[, granularity = 's'[, showAdverbs = false]]])
:Usage:
::value is a number of milliseconds
::friendly = true/false (false >>> 0d 00:00:00.000, true >>> so many days, so many hours, etc)
::granularity = one of ms, s, m, h, d (smallest part displayed)
::showAdverbs = true/false, true adds the in .... or .... ago to friendly times
:returns a nicely formatted string of time
:eg: formatDuration(12029) - 00:00:12 | formatDuration(12029, true) - 12 seconds | formatDuration(12029, true, "m") - 0 minutes | formatDuration(12029, true, "ms", true) - in 12 seconds and 29 milliseconds

;left(string, count)
:returns a substring of a value
:Example1: <code>left("hello world", 3)</code> outputs <code>hel</code>
:Example2: <code>left("hello world", 7)</code> outputs <code>hello w</code>

;lower(string)
:returns a lower case value of a string
:Example: <code>lower("HELLO WORLD")</code> outputs <code>hello world</code>

;mid(string, start, count)
:returns a substring of a value
:returns characters (including spaces) specified by count after start position from string
:Example1: <code>mid("hello world", 3, 4)</code> returns <code>lo w</code>
:Example2: <code>mid("hello world", 6, 3)</code> returns <code>wor</code>

;replace(string, search, replace[, [..], search, replace])
:replaces a search text inside of a value
:Example1: <code>replace("hello world", "world", "earth")</code> returns <code>hello earth</code>
:Example2: <code>replace(replace("[hello world]", "\[", "("),"\]",")")</code> returns <code>(hello world)</code>
: Note: There are special characters in regular expressions that needs to be escaped or the script will return an error, in the above example [ and ] are special characters.

;right(string, count)
:returns a substring of a value
;sprintf(format, arguments)
:formats a series of values into a string
;string(anything)
:converts a value to it's string value
;substring(string, start, count)
:returns a substring of a value
;text()
://todo
;title(string)
:returns a title case value of a string
;upper(string)
:returns an upper case value of a string

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type

Functions

2017-05-05T22:08:59Z

Ahndee: Add description for format()

= [[Variable_data_types#Boolean|Boolean]] =
;bool()
://todo
;boolean(anything)
:converts a value to it's boolean value
;contains(string, substring)
:returns true if a string contains a substring
;endsWith(string, substring)
:returns true if a string ends with a substring
;eq(value1, value2)
:returns true if two values are equal
;ge(value1, value2)
:returns true if value1 >= value2
;gt(value1, value2)
:returns true if value1 > value2
;isBetween(value, startValue, endValue)
:returns true if value >= startValue and value <= endValue
;isEmpty(value)
:returns true if the value is empty
;le(value1, value2)
:returns true if value1 <= value2
;lt(value1, value2)
:returns true if value1 < value2
;not(value)
:returns the negative boolean value
;startsWith(string, substring)
:returns true if a string starts with a substring

= [[Variable_data_types#Date|Date]] =
;date(value)
:returns the value as a date type

= [[Variable_data_types#Date_and_Time|Datetime]] =
;addDays(dateTime, days)
:returns the value as a time type
;addHours(dateTime, hours)
:returns the value as a time type
;addMinutes(dateTime, minutes)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:returns the value as a time type
;addWeeks(dateTime, weeks)
:returns the value as a time type

= [[Variable_data_types#Number_.28Decimal.29|Decimal]] =
;avg(values)
:calculates the average of a series of numeric values
;ceil()
://todo
;ceiling(decimal or string)
:converts a decimal value to it's closest higher integer value
;celsius(temperature)
:converts temperature from Fahrenheit to Celsius
;decimal(integer or string)
:converts an integer value to it's decimal value
;dewPoint(temperature, relativeHumidity[, scale])
:returns the calculated dew point temperature
;fahrenheit([Sensor;temperature])
:converts temperature from Celsius to Fahrenheit
;float()
://todo
;floor(decimal or string)
:converts a decimal value to it's closest lower integer value
;max(values)
:calculates the maximum of a series of numeric values
;median(values)
:returns the value in the middle of a sorted array
;min(values)
:calculates the minimum of a series of numeric values
;number()
://todo
;power(integer or decimal or string, power)
:converts a decimal value to it's power decimal value
;round(decimal or string, [precision])
:converts a decimal value to it's rounded value
;sqr(integer or decimal or string)
:converts a decimal value to it's square decimal value
;sqrt(integer or decimal or string)
:converts a decimal value to it's square root decimal value
;stdev(values)
:calculates the standard deviation of a series of numeric values
;sum(values)
:calculates the sum of a series of numeric values
;variance(values)
:calculates the standard deviation of a series of numeric values

= [[Variable_data_types#Dynamic|Dynamic]] =
;if(condition, valueIfTrue, valueIfFalse)
:evaluates a boolean and returns value1 if true, or value2 otherwise
;least(values)
:returns the value that is least found a series of numeric values
;most(values)
:returns the value that is most found a series of numeric values
;previousValue([device;attribute])
:returns the previous value of the attribute

= [[Variable_data_types#Number_.28Integer.29|Integers]] =
;age([device;attribute])
:returns the number of milliseconds an attribute had the current value
;count(values)
:calculates the number of true/non-zero/non-empty items in a series of numeric values
;int()
://todo
;integer(decimal or string)
:converts a decimal value to it's integer value
;newer([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for less than the specified number of milliseconds
;older([device;attribute],[...], [device;attribute], threshold)
:returns the number of devices whose attribute had the current value for more than the specified number of milliseconds
;previousAge([device;attribute])
:returns the number of milliseconds an attribute had the previous value

= [[Variable_data_types#String|String]] =
;concat(string1, string2)
:returns two strings appended together
: Example: <code>concat("hello ", "world")</code> or <code>concat("hello", " ", "world")</code> outputs <code>hello world</code>

;format(format string, values)
:Usage:
::formatString is a Java printf() type format string (see [https://sharkysoft.com/archive/printf/docs/javadocs/lava/clib/stdio/doc-files/specification.htm Reference])
::values is a dynamic length list of values (one entry for each % in the format string)
:returns a string with the placeholders replaced with the appropriately formatted values
: Example: <code>format('The temperature outside is %.2f degrees Fahrenheit', [Temp sensor:temperature])</code> outputs <code>The temperature outside is 71.26 degrees Fahrenheit</code>

;formatDuration(value[, friendly = false[, granularity = 's'[, showAdverbs = false]]])
:Usage:
::value is a number of milliseconds
::friendly = true/false (false >>> 0d 00:00:00.000, true >>> so many days, so many hours, etc)
::granularity = one of ms, s, m, h, d (smallest part displayed)
::showAdverbs = true/false, true adds the in .... or .... ago to friendly times
:returns a nicely formatted string of time
:eg: formatDuration(12029) - 00:00:12 | formatDuration(12029, true) - 12 seconds | formatDuration(12029, true, "m") - 0 minutes | formatDuration(12029, true, "ms", true) - in 12 seconds and 29 milliseconds

;left(string, count)
:returns a substring of a value
:Example1: <code>left("hello world", 3)</code> outputs <code>hel</code>
:Example2: <code>left("hello world", 7)</code> outputs <code>hello w</code>

;lower(string)
:returns a lower case value of a string
:Example: <code>lower("HELLO WORLD")</code> outputs <code>hello world</code>

;mid(string, start, count)
:returns a substring of a value
:returns characters (including spaces) specified by count after start position from string
:Example1: <code>mid("hello world", 3, 4)</code> returns <code>lo w</code>
:Example2: <code>mid("hello world", 6, 3)</code> returns <code>wor</code>

;replace(string, search, replace[, [..], search, replace])
:replaces a search text inside of a value
:Example1: <code>replace("hello world", "world", "earth")</code> returns <code>hello earth</code>
:Example2: <code>replace(replace("[hello world]", "\[", "("),"\]",")")</code> returns <code>(hello world)</code>
: Note: There are special characters in regular expressions that needs to be escaped or the script will return an error, in the above example [ and ] are special characters.

;right(string, count)
:returns a substring of a value
;sprintf(format, arguments)
:formats a series of values into a string
;string(anything)
:converts a value to it's string value
;substring(string, start, count)
:returns a substring of a value
;text()
://todo
;title(string)
:returns a title case value of a string
;upper(string)
:returns an upper case value of a string

= [[Variable_data_types#Time|Time]] =
;time(value)
:returns the value as a time type
;addSeconds(dateTime, seconds)
:adds seconds to time, returns the value as a time type
;addMinutes(dateTime, minutes)
:adds minutes to time, returns the value as a time type
;addHours(dateTime, hours)
:adds hours to time, returns the value as a time type
;addDays(dateTime, days)
:adds days to time, returns the value as a time type
;addWeeks(dateTime, weeks)
:adds weeks to time, returns the value as a time type