ezeio documentation - ezeio2:expref

Alarm status

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:46:02+00:00

Alarm status a( alarmno ) Return the current status of an alarm. Description a( alarmno ) This function returns the current status of a given alarm. Parameters alarmno Alarm number (1 - 200) Return value Returns the current status of the alarm. The return value will be 0 if the alarm is not active. If the alarm is active, the return value is 1.

Absolute value

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:46:19+00:00

Absolute value abs( a ) Returns the absolute value of a. Description abs( a ) Returns |a| Parameters a Value Return value This function returns the absolute value of a. Example usage abs( -123 ) Returns 123.

Arc Cosine

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:46:36+00:00

Arc Cosine acos( a ) Return the arc cosine of a. Description acos( a ) Return the arc cosine of a in radians. Parameters a Value [-1 to +1] Return value arc cosine of a Example usage acos( 1 ) Returns 0.

Analog input value

Anonymous (anonymous@undisclosed.example.com) — 2024-08-01T20:14:42+00:00

Analog input value adc( inputnumber ) Returns the value of a physical input. Description adc( inputnumber ) Returns the value read on the ADC for the given input. Parameters inputnumber Physical input number (1-8) Return value This function returns the value read on the given input. The unit depends on the configured mode.

Alarm Information

Anonymous (anonymous@undisclosed.example.com) — 2020-10-08T23:28:24+00:00

Alarm Information ai(alarmno, mode) Returns information of a given alarm. Description ai(3, AL_HOLDOFF) Returns the remaining holdoff time for alarm #3. Parameters alarmno Alarm number mode What information is requested mode AL_STATE The alarm state (1=in alarm, 0=not in alarm)

Arc Sine

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:46:54+00:00

Arc Sine asin( a ) Return the arc sine of a. Description asin( a ) Return the arc sine of a in radians. Parameters a Value [-1 to +1] Return value arc sine of a Example usage asin( 1 ) Returns 1.57079... (PI/2).

Arc Tangent

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:47:49+00:00

Arc Tangent atan( a ) Return the arc tangent of a. Description atan( a ) Return the arc tangent of a. Parameters a Angle in radians [-1 to +1] Return value arc tangent of a Example usage atan( 1 ) Returns 0.7854...

Bit

Anonymous (anonymous@undisclosed.example.com) — 2020-10-09T01:07:20+00:00

Bit bit(value, bitno) Returns the status of the given bit in an integer value Description bit(19, 1) Returns the value of bit 1 (the second bit) in the value 19. 19 (decimal) written as binary is 10011. Thus, bit 4, 1 and 0 are set. Bit 0 is the first from the right.

Boolean

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:48:00+00:00

Boolean bool( a ) Returns 1 if the value a is larger than 0. Returns 0 if a is zero or negative. Description bool( a ) Returns 1 if the value a is larger than 0. Returns 0 if a is zero or negative. Parameters a Any value Return value If a>0, returns 1. Else returns 0.

Celsius to Kelvin

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:48:24+00:00

Celsius to Kelvin C2K( celsius ) Returns the temperature converted from Celsius to Kelvin Description C2K( celsius ) Returns the given temperature in Kelvin. Parameters celsius Temperature in Celsius Return value This function converts the given temperature from Celsius to Kelvin degrees.

Cosine

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:48:35+00:00

Cosine cos( a ) Return the cosine of a. Description cos( a ) Return the cosine of a, where a is the angle in radians. Parameters a Angle in radians Return value cosine of a Example usage cos( PI/2 ) Returns 0.

Day

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:48:46+00:00

Day Day() Returns the current day of the month. Description Day() Returns the current day of the month, 1 to 31. Parameters none Return value This function returns the current day of the month in the time zone set for the ezeio. Example usage

Device Status

Anonymous (anonymous@undisclosed.example.com) — 2021-02-24T18:55:52+00:00

Device Status ds( deviceno, subject ) Return the current status of a device. Description ds( deviceno, subject ) This function returns the current status of a device or the aggregate status of all devices. Parameters deviceno Device number (1 - 40). If 0 (zero), the function returns the aggregate status of ALL devices.

Elevation

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:49:24+00:00

Elevation Elev() Returns the elevation as reported by a GPS. Description Elev() Returns the elevation in meters as reported by a GPS module. If no positioning data is available (or no GPS is attached), this will return 0. Parameters none Return value

Field value from remote unit

Anonymous (anonymous@undisclosed.example.com) — 2021-03-18T21:11:27+00:00

Field value from remote unit =XYZ-987,12 Return recent value of a field from a remote unit Description ={serial},{fieldno} This function returns the most recent value of a field on a remote unit. Note that the data is updated every 10 minutes (fixed), and that the two units must be assigned to the same account.

Exponent

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:49:35+00:00

Exponent exp( a ) Returns the value of e raised to the a:th power. Description exp( a ) returns the value of e raised to the a:th power. Parameters a Value Return value This function returns the exponential value of x. Example usage exp( 1 )

Field value

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:49:47+00:00

Field value f( fieldno ) Return the current value of a field. Description f( fieldno ) This function returns the current value of a given field. Parameters fieldno Field number (1 through 90) Return value Returns the current value of the field.

Farenheit to Kelvin

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:50:02+00:00

Farenheit to Kelvin F2K( farenheit ) Returns the temperature converted from Farenheit to Kelvin Description F2K( farenheit ) Returns the given temperature in Kelvin. Parameters farenheit Temperature in Farenheit Return value This function converts the given temperature from Farenheit to Kelvin degrees.

Field value from log data

Anonymous (anonymous@undisclosed.example.com) — 2021-06-03T16:05:32+00:00

Field value from log data fh( fieldno, seconds ) Return the field value from the log data, from seconds ago. Description fh( fieldno, seconds ) This function returns the logged value of a given field, from seconds ago. If the field is configured for faster logging than the default 10 minutes, the fh function will attempt to fetch the data from the 'fast log' buffer.

Floor

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:50:11+00:00

Floor floor( a ) Returns a rounded down to the closest integer. Description floor( a ) Returns the value of a rounded down to the closest integer. Parameters a Value Return value This function returns the largest integral value not greater than a.

From/In range

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:50:29+00:00

From/In range from( value, range ) Check if the value is between 0 and the range. Description from( value, range ) This function is commonly used with the time() function to evaluate a time range. Parameters value Value to evaluate range Range to compare to

Hour, Minute, Second

Anonymous (anonymous@undisclosed.example.com) — 2019-09-25T00:25:45+00:00

Hour, Minute, Second HMS() Return encoded hour-minute-second Description HMS() This function returns the current local time of day as HHMMSS. Parameters none Return value Returns current time of day as HHMMSS. Example usage HMS()>123400 // returns 1 if time is past 12:34 HMS()>93000 && HMS()<180500 // returns 1 if time is between 9:30 and 18:05

Hour

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:50:39+00:00

Hour Hour() Returns the current hour Description Hour() Returns the current hour, 0-23. Parameters none Return value This function returns the current hour in the time zone set for the ezeio. Example usage Hour()

Kelvin to Celsius

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:50:54+00:00

Kelvin to Celsius K2C( kelvin ) Returns the temperature converted from Kelvin to Celcius Description K2C( kelvin ) Returns the given temperature in Celcius. Parameters kelvin Temperature in Kelvin Return value This function converts the given temperature from Kelvin degrees to Celcius.

Kelvin to Farenheit

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:51:08+00:00

Kelvin to Farenheit K2F( kelvin ) Returns the temperature converted from Kelvin to Farenheit Description K2F( kelvin ) Returns the given temperature in Farenheit. Parameters kelvin Temperature in Kelvin Return value This function converts the given temperature from Kelvin degrees to Farenheit.

Latitude

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:51:18+00:00

Latitude Lat() Returns the Latitude as reported by a GPS. Description Lat() Returns the Latitude in degrees as reported by a GPS module. If no positioning data is available (or no GPS is attached), this will return 0. Parameters none Return value

Natural Logarithm

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:51:37+00:00

Natural Logarithm ln( a ) Return the natural logarithm of a. Description ln( a ) Returns the natural logarithm (base-e logarithm) of a. Parameters a Value Return value This function returns natural logarithm of a. Example usage ln( 20 )

Common Logarithm

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:51:57+00:00

Common Logarithm log( a ) Returns the common logarithm (base-10 logarithm) of a. Description log( a ) Returns the common logarithm (base-10 logarithm) of a. Parameters a Value Return value This function returns the common logarithm of a, for values of a greater than zero.

Longitude

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:52:09+00:00

Longitude Long() Returns the Longitude as reported by a GPS. Description Long() Returns the Longitude in degrees as reported by a GPS module. If no positioning data is available (or no GPS is attached), this will return 0. Parameters none Return value

Max

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:52:21+00:00

Max max( a, b ) Return the larger value of a or b. Description max( a, b ) This function returns the larger of the two values, a or b. Parameters a Any value b Any value Return value If a>=b, returns the value a If a

Min

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:52:30+00:00

Min min( a, b ) Return the smaller value of a or b. Description min( a, b ) This function returns the smaller of the two values, a or b. Parameters a Any value b Any value Return value If a>=b, returns the value b If a

Minute

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:52:39+00:00

Minute Minute() Returns the current minute Description Minute() Returns the current minute, 0-59. Parameters none Return value This function returns the current minute in the time zone set for the ezeio. Example usage Minute()

Month

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:52:49+00:00

Month Month() Returns the current month. Description Month() Returns the current month number (1-12) Parameters none Return value This function returns the current month in the time zone set for the ezeio. Example usage Month()

Operators and Constants

Anonymous (anonymous@undisclosed.example.com) — 2021-06-08T16:35:32+00:00

Operators and Constants Operators and constants The following operators are supported in expressions: Operator Name Description Example usage + Addition Adds two numbers 5+PI (8.14159..) - Subtraction Subtracts a number from another Year()-2000

Register value

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:53:25+00:00

Register value r( deviceno, registerno ) Return the current value of a register. Description r( deviceno, registerno ) This function returns the current value of a given register. Parameters deviceno Device number (1 - 40) registerno Register number on the device (1 - 150)

Register value

Anonymous (anonymous@undisclosed.example.com) — 2025-03-14T18:19:52+00:00

Register value ra( deviceno, registerno ) Return the age of a register. Description ra( deviceno, registerno ) This function returns the number of seconds passed since the register was updated. Each time SetRegister is called, the age is reset to 0 - even if the value written to the register is the same.

Random number

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:53:38+00:00

Random number rand( a ) Returns a random number between 0 and a. Description rand( a ) Returns a random number between 0 (inclusive) and a (exclusive). Parameters a Upper limit for random number Return value This function returns a random number.

Round

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:53:47+00:00

Round round( a ) Returns a rounded to the nearest integer. Description round( a ) Returns the value of a rounded to the nearest integer, or away from zero if the fraction is 0.5. Parameters a Value Return value This function returns a rounded to the nearest integer.

Real time / EPOCH

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:54:02+00:00

Real time / EPOCH RTC() Returns the epoch / unixtime. Description RTC() Returns the number of seconds since 1970-01-01 00:00:00. Parameters none Return value This function returns the epoch/unix timestamp as seconds. Example usage RTC()

Schedule status

Anonymous (anonymous@undisclosed.example.com) — 2020-07-23T22:06:07+00:00

Schedule status sch( ) Returns the status of the schedule number referenced Returns 1 if currently in schedule. Returns 0 if currently out of schedule. Description sch( # ) Returns 1 if “in schedule. Returns 0 if “out of schedule”. Parameters

Second

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:54:15+00:00

Second Second() Returns the current second Description Second() Returns the current second, 0-59. Parameters none Return value This function returns the current second. Example usage Second()

Sine

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:54:25+00:00

Sine sin( a ) Return the sine of a. Description sin( a ) Return the sine of a, where a is the angle in radians. Parameters a Angle in radians Return value sine of a Example usage sin( PI/2 ) Returns 1.

Square root

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:54:38+00:00

Square root sqrt( a ) Returns the square root of a. Description sqrt( a ) Returns the square root of the value a. Parameters a Value Return value This function returns the square root of the value a. Example usage sqrt( 256 ) Returns 16.

Expressions

Anonymous (anonymous@undisclosed.example.com) — 2022-11-16T23:50:44+00:00

Expressions Within the configuration of an ezeio, mathematical expressions are used to produce a value/result for “Fields”, “Alarms” and “Conditions”. This powerful tool can produce mathematical and logical results using multiple constants and/or variables from the available resources on an ezeio. Expressions can be as simple as the constant

System Item

Anonymous (anonymous@undisclosed.example.com) — 2020-01-24T18:15:27+00:00

System Item sys( subject ) Return a system status value. Description sys( subject ) This function returns the current value of a system item. Parameters subject Subject to request (see below) Subject Description SYSITEM_GPSX Current GPS longitude in degrees x 10

Tangent

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:54:48+00:00

Tangent tan( a ) Return the tangent of a. Description tan( a ) Return the tangent of a in radians. Parameters a Value Return value Tangent of a in radians Example usage tan( PI/4 ) Returns 1.

This (field/alarm number)

Anonymous (anonymous@undisclosed.example.com) — 2023-08-13T07:24:29+00:00

This (field/alarm number) THIS Holds the index number of the current field or alarm Description THIS THIS is useful to self-reference a field or alarm. For example to let a field self-increment, the following expression can be used: f(THIS)+1

Time to

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:55:11+00:00

Time to time( hour, minute ) Return the difference between current local time and the given time. Description time( hour, minute ) This function returns the difference in minutes between the current local time of the controller and the time given in the command.

Uptime

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:55:21+00:00

Uptime Uptime() Return number of seconds since last reset. Description Uptime() This function returns the number of seconds since last reset. The cause of a reset may be: * Power being removed/restored * Software reset due to firmware update

Week

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:55:29+00:00

Week Week() Returns the current week number. Description Week() Returns the current week number of the year. Parameters none Return value This function returns the current week number of the current year. Example usage Week()

Weekday

Anonymous (anonymous@undisclosed.example.com) — 2019-09-02T18:55:40+00:00

Weekday Weekday() Returns the current weekday. Description Weekday() Returns the current weekday, 0 (Sunday) to 6 (Saturday). Parameters none Return value This function returns the current weekday in the time zone set for the ezeio. Example usage

User defined memory

Anonymous (anonymous@undisclosed.example.com) — 2021-07-20T01:04:47+00:00

User defined memory v( address ) / vf( address ) Returns the value of a user-defined cell. Description v( ADDRESS ) vf( ADDRESS) Returns the value of the cell. v() assumes the cell contains an integer value. vf() assumed the cell contains a floating point value.

Year, Month, Day

Anonymous (anonymous@undisclosed.example.com) — 2019-09-25T00:27:47+00:00

Year, Month, Day YMD() Return encoded year-month-day Description YMD() This function returns the current local date as YYYYMMDD Parameters none Return value Returns current date as YYYYMMDD. Example usage YMD()>20190515 // returns 1 if date is past May 15, 2019.