https://doc.eze.io/ 2026-04-29T14:17:37+00:00 https://doc.eze.io/ https://doc.eze.io/_media/logo.png text/html 2021-09-27T22:44:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/abs?rev=1632782678&do=diff ABS Macro that will return the absolute value Description ABS( number ) Returns the absolute value of the given number. Works with both float and integer parameters. Parameters number input value Return value Returns the absolute value of number text/html 2020-09-16T23:23:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/adjustfield?rev=1600298582&do=diff AdjustField Adjust the value of a field. Description AdjustField( fieldno, Float:value ) Adds the given value to the field value. This command performs the addition with double (64-bit) math. It may be useful for accumulating values that can grow very large, in which case this command can be used to maintain precision. text/html 2023-07-27T17:17:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/allocregisters?rev=1690478268&do=diff AllocRegisters Reserve registers for a device driver Description AllocRegisters( deviceno, registercount ) This command allocates registers for a device driver. Repeated calls will not reset the registers unless the register count changes. There is no need to de-allocate registers as the system will automatically free registers that are not in use. text/html 2023-08-18T23:50:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/bufdec?rev=1692402613&do=diff BufDec Decode a part of a buffer into a scalar Description BufDec( const buf[], offset, method ) This command will decode a portion of a buffer into a scalar variable. Parameters buf Data buffer offset Byte offset into the buffer where to start the decoding text/html 2020-08-14T23:36:20+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/c2f?rev=1597448180&do=diff C2F Helper function to convert from Celsius degrees to Farenheit Description Float:C2F( Float:C ) Return Farenheit from degrees Celsius. Parameters C Degrees Celsius Return value Degrees Farenheit Example usage new Float:F = C2F( 10.0 ); // F = 50.0; text/html 2019-11-19T00:19:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/clamp?rev=1574122761&do=diff CLAMP Macro that will return a value limited to a given range Description CLAMP( value, minimum, maximum ) Returns the value if it is within the range minimum to maximum. If the value is smaller than minimum, returns minimum. If the value is larger than text/html 2019-09-02T21:37:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/csvtoint?rev=1567460242&do=diff CSVtoInt Extract a single parameter from a CSV formatted string. Description CSVtoInt( const data[], item, decimals ) Extract single numeric parameter from a CSV formatted string. Parameters data CSV formatted string item Which item to extract. The first item is 1. text/html 2019-09-02T21:37:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/csvtostr?rev=1567460256&do=diff CSVtoStr Extract a single parameter from a CSV formatted string. Description CSVtoStr( const data[], destination[], maxlen, item ) Extract single parameter from a CSV formatted string. Parameters data CSV formatted string destination Buffer for extracted parameter text/html 2020-08-14T20:54:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/dewpoint?rev=1597438452&do=diff Dewpoint Helper function to calculate dewpoint from temperature and relative humidity Description Float:Dewpoint( Float:temp, Float:RH ) Calculates dewpoint in degrees Celsius. This functions uses the Magnus-Tetens formula. Parameters temp Temperature in degrees Celsius (-45 to +60 °C) text/html 2024-06-07T19:34:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/doalarm?rev=1717788898&do=diff DoAlarm Trigger activation of an alarm. Description DoAlarm( alarmno, force, dparam, iparam1, iparam2, text, ... ) This command will change the state of an alarm into active and trigger any alarm actions accordingly. If the force parameter is 0/false and the alarm is already in active state, the actions are not re-triggered. text/html 2024-06-07T19:35:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/dorestore?rev=1717788912&do=diff DoRestore Trigger restore of an alarm. Description DoRestore( alarmno, force, dparam, iparam1, iparam2, text, ... ) This command will change the state of an alarm into restored and trigger any alarm actions accordingly. If the force parameter is 0/false and the alarm is not in active state, the actions are not re-triggered. text/html 2023-11-30T18:00:20+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/eval?rev=1701367220&do=diff Eval Evaluates the supplied string using the expression parser Description Float:Eval( const string[] ) Return the resulting value. If the expression is invalid, the return value is zero (0.000) NOTE: The Eval script function does not support tags. text/html 2020-08-14T23:34:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/f2c?rev=1597448086&do=diff F2C Helper function to convert from Farenheit degrees to Celsius degrees Description Float:F2C( Float:F ) Return degrees Celsius from Farenheit. Parameters F Degrees Farenheit Return value Degreees Celsius Example usage new Float:C = F2C( 50.0 ); // C = 10.0 text/html 2021-09-27T22:44:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/facos?rev=1632782687&do=diff facos Find the arc-cosine of a value Description Float:facos( Float:value ) Find the arc-cosine of the given value. The return value is in radians. Parameters value input value Return value Returns the arc-cosine in radians of value. Example usage text/html 2021-09-27T22:44:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fasin?rev=1632782694&do=diff fasin Find the arc-sine of a value Description Float:fasin( Float:value ) Find the arc-sine of the given value. The return value is in radians. Parameters value input value Return value Returns the arc-sine in radians of value. Example usage text/html 2019-11-18T23:40:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fatan?rev=1574120401&do=diff fatan Find the arc-tangent of a value Description Float:fatan( Float:value ) Find the arc-tangent of the given value in radians. Parameters value input value in radians Return value Returns the arc-tangent value. Example usage new Float:x; x = fatan( 1 ); // 0.785398.. text/html 2019-11-18T23:43:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fatan2?rev=1574120639&do=diff fatan2 Find the 2-argument arc-tangent Description Float:fatan2( Float:x, Float:y ) Find the Euclidean plane for the point (x,y) The return value is in radians. Parameters x x-axis offset y y-axis offset Return value Returns the arc-tangent in radians for the point (x,y) text/html 2019-11-18T23:27:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fcos?rev=1574119655&do=diff fcos Find the cosine of a value Description Float:fcos( Float:value ) Find the cosine of the given value. The value is assumed to be in radians. Parameters value input value (angle in radians) Return value Returns the cosine of value. Example usage text/html 2019-11-18T23:21:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/flog?rev=1574119314&do=diff flog Find the logarithm of a value Description Float:flog( Float:value, Float:base=10.0 ) Find the logarithm of the given value, using the given base. By default flog returns log10. To return the natural logarithm, use flog( value, E ). Parameters text/html 2020-08-14T20:17:37+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/forcealarm?rev=1597436257&do=diff ForceAlarm Force activation of an alarm. Description ForceAlarm( alarmno ) This command will force the state of an alarm into active and trigger any alarm actions accordingly. The alarm will be triggered even if the alarm is already active. If the alarm is not active, the restore logic and holdoff will determine if/when the restore actions will execute. text/html 2020-08-14T20:18:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/forcerestore?rev=1597436337&do=diff ForceRestore Force restore of an alarm. Description ForceRestore( alarmno ) This command will force the state of an alarm into restore and trigger any restore actions accordingly. The restore actions will be tripped even if the alarm state is already restored. If the alarm condition is fulfilled, the alarm condition/holdoff will determine if/when the alarm activates again. text/html 2023-10-26T18:12:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fpow?rev=1698343932&do=diff fpow Return a value raised to an exponent Description Float:fpow( Float:value, Float:exponent ) Raise value to exponent Parameters value input value exponent exponent Return value Returns (value)(exponent) Example usage new Float:x; x = fpow( 3, 4 ); // 81 x = fpow( 7.39, E ); // 2.0001.. (=natural logarithm) text/html 2019-11-18T23:01:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fround?rev=1574118100&do=diff fround Return a float value rounded off to an integer Description fround(Float:value, method=floatround_round) Round the value to an integer, using the method given by method. Parameters value Floating point value to be rounded method Rounding method, default to nearest integer text/html 2019-11-18T23:26:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fsin?rev=1574119581&do=diff fsin Find the sine of a value Description Float:fsin( Float:value ) Find the sine of the given value. The value is assumed to be in radians. Parameters value input value (angle in radians) Return value Returns the sine of value. Example usage text/html 2019-11-18T23:05:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fsqrt?rev=1574118359&do=diff fsqrt Find the square root Description Float:fsqrt( Float:value ) Find the square root of the given value Parameters value input value (must be non-negative) Return value Returns the square root of value Example usage new Float:x; x = fsqrt( 12.25 ); // 3.5 text/html 2024-02-05T23:17:59+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/fstrval?rev=1707175079&do=diff fstrval Evaluate a string to a float value Description Float:fstrval( const str[], index=0, limit=15 ) Evaluate the string, starting at the index position for a float value Max limit characters will be evaluated, starting at the index position. text/html 2019-11-18T23:35:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/ftan?rev=1574120122&do=diff ftan Find the tangent of a value Description Float:ftan( Float:value ) Find the tangent of the given value. The return value is in radians. Parameters value input value Return value Returns the tangent in radians of value. Example usage new Float:x; x = ftan( PI/4 ); // 1 text/html 2020-10-08T23:21:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getalarminfo?rev=1602199267&do=diff GetAlarmInfo Return the current information about the alarm Description GetAlarmInfo( alarmno, mode ) Fetch the given information about the current alarm state. Parameters alarmno The alarm number mode One of the modes below mode parameter, one of: text/html 2019-09-02T21:38:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getalarmstate?rev=1567460289&do=diff GetAlarmState Return the current state of the alarm Description GetAlarmState( alarmno ) Fetch the state of a given alarm. Parameters alarmno The alarm number Return value Returns the current state of the alarm. 1=alarm is active. 0=alarm is not active. text/html 2020-08-14T20:40:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getbit?rev=1597437610&do=diff GetBit Helper function to read the state of a single bit in a byte-buffer. Description GetBit( buffer, bitno ) Get the state of a single bit in a buffer Parameters buf Reference to the byte buffer bitno The bit number (0-indexed) Return value text/html 2024-04-10T18:04:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getcellbit?rev=1712772278&do=diff GetCellBit Helper function to read the state of a single bit in a cell. Description GetCellBit( value, bitno ) Get the state of a single bit in the cell value Parameters value 32-bit cell value bitno The bit number (0-indexed) Return value text/html 2021-06-14T22:45:34+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getdevicestatus?rev=1623710734&do=diff GetDeviceStatus Fetch the Comm / Op / App status of a given device (or aggregate status) Description GetDeviceStatus( deviceno, status item ) Returns the given status item for. Parameters deviceno Device number to request status from (or 0 for all devices) text/html 2020-09-16T23:17:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getfield?rev=1600298224&do=diff GetField/GetFieldFloat Get the value of a field Description GetField( fieldno ) Float:GetFieldFloat( fieldno ) Fetches the value of a field Parameters fieldno Which field to fetch Return value The value of the field. GetField will return the value rounded to the nearest integer. text/html 2022-05-17T14:41:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getfieldlog?rev=1652798468&do=diff GetFieldLog Get the value of a field from the log data Description GetFieldLog( fieldno, seconds ) Float:GetFieldLog( fieldno, seconds, FLOAT ) Fetches the value of a field from the log data buffer Available in firmware 21060101 or newer Parameters text/html 2025-07-10T18:28:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getinputmode?rev=1752172116&do=diff GetInputMode Get the input mode on a native ezeio input. Description GetInputMode( inputno ) This will get the hardware input mode on a ezeio input. The command only works on native ezeio inputs - on the ezeio controller or ezeio expansion I/O devices. Third party modules use different methods to change input configuration. text/html 2019-09-02T21:38:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getinputvalue?rev=1567460311&do=diff GetInputValue Fetch the value of a hardware input. Description GetInputValue( inputno, mode ) The value returned will depend on the hardware mode of the input, which should have been set already using the SetInputMode command. Parameters inputno Input number to read. Inputs 1-8 are on the ezeio. Use text/html 2019-09-02T21:38:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getoutput?rev=1567460322&do=diff GetOutput Get the state of an output Description GetOutput( outputno ) Return the current state of a native ezeio output. The output value is always in percent , 0-100. For digital outputs, any value 50 and higher will set the output to ON (100%). text/html 2020-08-14T20:21:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getregister?rev=1597436515&do=diff GetRegister Get the value of a register Description GetRegister( deviceno, registerno, {type} ) Fetches the value of a register Parameters deviceno Device number (1-40) registerno Which register to fetch type (optional) a variable that will be set to the register type (NULL/UINT/INT/FLOAT) text/html 2024-05-22T21:44:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getregisterstatus?rev=1716414268&do=diff GetRegisterStatus Get status of a register Description GetRegisterStatus( deviceno, registerno, parameter ) Fetches the status of a register Parameters deviceno Device number (1-40) registerno Which register to fetch parameter The parameter to request, one of text/html 2025-02-11T23:18:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getsystemitem?rev=1739315889&do=diff GetSystemItem Fetch the value of a given system parameter Description GetSystemItem( item ) Returns the value of a given system parameter Parameters item The system item to return (see below) Parameter Description SYSITEM_GPSX GPS latitude in degrees x 10 text/html 2019-11-19T00:08:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/gettimer?rev=1574122097&do=diff GetTimer Get the current state of a timer Description GetTimer( timerno, mode=0 ) Return the current state of a timer. Parameters timerno Timer number 0-3 mode mode - see below mode is one of: TIMER_REMAIN Returns remaining time on the timer in milliseconds (default) text/html 2022-07-13T17:03:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/getval?rev=1657731831&do=diff GetVal Get value of a user-defined memory cell Description GetVal( address ) Fetch the value of one of the user defined memory cells. There are 512 32-bit cells available. The values are stored in NVM, so they will remain through power loss/reset. text/html 2019-09-02T21:39:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/ispacked?rev=1567460353&do=diff ispacked Tests a string for how it is stored. Description ispacked( const string[] ) Tests a string for how it is stored. See Pawn documentation about string packed/unpacked storage. By default all strings are packed in the ezeio. Parameters string text/html 2020-08-14T23:31:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/k2c?rev=1597447882&do=diff K2C Helper function to convert from Kelvin degrees to Celsius degrees Description Float:K2C( Float:K ) Return degrees Celsius from Kelvin. Parameters K Degrees Kelvin Return value Degreees Celsius Example usage new Float:C = K2C( 280.15 ); // C = 7.0; text/html 2020-08-14T23:36:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/k2f?rev=1597448203&do=diff K2F Helper function to convert from Kelvin degrees to Farenheit degrees Description Float:K2F( Float:K ) Return degrees Farenheit from Kelvin. Parameters K Degrees Kelvin Return value Degreees Farenheit Example usage new Float:F = K2F( 280.15 ); // F = 44.6; text/html 2020-08-14T23:27:56+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/linfit?rev=1597447676&do=diff Linfit Linear regression. Attempt to find best fit y=ax+b function given multiple x/y points. Description Linfit( Float:x[], Float:y[], points, &Float:a, &Float:b ) Find the best fitting y=ax+b function using least-square method. Parameters x[] text/html 2022-11-09T19:51:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/localtime?rev=1668023461&do=diff localtime Split Unixtime into components Description localtime(timestamp, local=0, year, month, day, hour, minute, second, weekday, yearday) Split the timestamp into components. Parameters timestamp Unix timestamp (seconds since 1970-01-01, UTC) text/html 2019-11-19T00:14:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/max?rev=1574122443&do=diff MAX Macro that will return the larger of two values Description MAX( value1, value2 ) Returns the larger of two values Works with both float and integer parameters. Parameters value1 input value value2 input value Return value Returns the larger of text/html 2023-10-02T18:51:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/mbrtu_read?rev=1696272700&do=diff MBRTU_Read Read a single register from a Modbus/RTU device Description MBRTU_Read(unitid, cmd, reg, format=BT_UINT16, &error) This command issues a Modbus/RTU read command and waits for a valid reply. If an error occurrs (timeout, or error reply from the device), the error parameter is set to a non-zero value. text/html 2023-10-02T18:52:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/mbtcp_read?rev=1696272723&do=diff MBTCP_Read Read a single register from a Modbus/TCP server Description MBTCP_Read(ip, unitid, cmd, reg, format=BT_UINT16, &error) This command issues a Modbus/TCP read command and waits for a valid reply. If an error occurs (timeout, or error reply from the device), the error parameter is set to a non-zero value. text/html 2019-11-18T22:37:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/memcpy?rev=1574116670&do=diff memcpy Copy byte buffer Description memcpy( dest[], source[], index, length ) Copy the source string to dest, starting at the index byte in dest, and counting length bytes. Parameters dest destination buffer source string to be copied index text/html 2019-11-19T00:15:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/min?rev=1574122501&do=diff MIN Macro that will return the smaller of two values Description MIN( value1, value2 ) Returns the smaller of two values Works with both float and integer parameters. Parameters value1 input value value2 input value Return value Returns the smaller of text/html 2022-11-09T19:50:33+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/mktime?rev=1668023433&do=diff mktime Convert time and date into Unixtime value Description mktime(year, month, day, hour, minute, second, [local]) The date and time will be converted into a Unixtime value (seconds since UTC 1970-01-01). By default (of local is false/zero or not included), the date is handled as UTC. If text/html 2023-10-02T17:47:56+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/modbusportconfig?rev=1696268876&do=diff ModbusPortConfig Configure the RS485 port Modbus/RTU settings Description ModbusPortConfig( speed, settings ) This command will configure the RS485 port. Parameters speed Desired bit rate (1200 - 115200 bps) settings Bitmap combination of UART_WLEN_*, UART_STOP_* and UART_PAR_* text/html 2019-09-02T21:40:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/pdebug?rev=1567460415&do=diff PDebug Print to the debug terminal Description PDebug( const text[], ... ) Print a string to the debug terminal if it is open and active. Parameters text String to print with optional formatting placeholders ... Optional parameters Formats a text string and outputs it to the debug terminal. If the debug terminal is not open and active, this command has no effect. Messages are not buffered. They will only be sent and printed if the terminal is open. text/html 2022-03-30T23:44:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/pid_new?rev=1648683864&do=diff PID-functions Set of helper functions to initiate and update a PID control loop Description PID_new( pid[], Float:set, Float:out ) // set up new PID PID_dir( pid[], direction ) // set direction of control PID_set( pid[], Float:set ) // adjust the target value text/html 2026-01-08T01:13:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/ping?rev=1767834821&do=diff Ping Sends an ICMP (Ping) to another Ethernet connected device Description Ping( IP1, IP2, IP3, IP4 ) Ping( IP4 ) Send a 32 byte packet to other device and return the roundtrip time in milliseconds Parameters IP1 First IPv4 octet IP2 Second IPv4 octet text/html 2026-01-08T01:42:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/regdirty?rev=1767836563&do=diff RegDirty Find if a register value has been written to by any external process Description RegDirty( nDvc, nReg ) Returns 1 if the register has been written to by any other driver or system function. Returns 0 if not. Parameters nDvc Driver number text/html 2022-03-28T17:19:32+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/requesthibernate?rev=1648487972&do=diff requestHibernate Request from the ezeio to enter a hibernation cycle Description requestHibernate( cycles ) This will cause the ezeio to send a request to hibernate to the servers following the next 10 minute log collection. Please read the section about text/html 2020-08-14T20:42:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setbit?rev=1597437773&do=diff SetBit Helper function to set the state of a single bit in a byte-buffer. Description SetBit( buffer, bitno, value ) Set the state of a single bit in a buffer Parameters buf Reference to the byte buffer bitno The bit number (0-indexed) value text/html 2024-04-10T18:08:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setcellbit?rev=1712772482&do=diff SetCellBit Helper function to set the state of a single bit in a cell value. Description SetCellBit( cell, bitno, value ) Set the state of a single bit in a cell variable Parameters cell The cell variable to manipulate bitno The bit number (0-indexed) text/html 2021-06-14T22:51:33+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setdevicestatus?rev=1623711093&do=diff SetDeviceStatus Set the device status Description SetDeviceStatus( deviceno, status item, new value ) This function returns no value. Parameters deviceno Device number to set status item The status item to set (see GetDeviceStatus) new value text/html 2026-01-08T01:43:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setdriverno?rev=1767836592&do=diff SetDriverNo System function to capture the driver number from the script Description SetDriverNo( n ) Saves the driver number internally Parameters This function is used by system drivers to capture the current driver number. There is no case where this function should be used in a user script. text/html 2020-09-16T23:15:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setfield?rev=1600298112&do=diff SetField/SetFieldFloat Set the value of a field Description SetField( fieldno, value ) SetFieldFloat( fieldno, Float:value ) Set the integer or float value of a field and flag the value as changed. Note that the Math logic for the field is continuously evaluated, so if the math logic results in a different value, it will immediately overwrite the value set by this command. To only set the field from script logic, leave the Math blank. text/html 2019-09-02T21:41:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setinputmode?rev=1567460481&do=diff SetInputMode Set the input mode on a native ezeio input. Description SetInputMode( inputno, mode ) This will set the hardware input mode on a ezeio input. The command only works on native ezeio inputs - on the ezeio controller or ezeio expansion I/O devices. Third party modules use different methods to change input configuration. text/html 2023-10-02T17:51:16+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setmodbustimeout?rev=1696269076&do=diff SetModbusTimeout Set the bus timeout for Modbus/RTU communication Description SetModbusTimeout( ms ) Set the timeout in milliseconds that bus commands will wait for a device to reply. Parameters ms Timeout in milliseconds Return value This function returns no value. text/html 2019-09-02T21:41:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setoutput?rev=1567460507&do=diff SetOutput Set an output Description SetOutput( outputno, value ) Directly set the value/state of a native ezeio output. The output value is always in percent , 0-100. For digital outputs, any value 50 and higher will set the output to ON (100%). text/html 2020-08-14T20:19:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setregister?rev=1597436388&do=diff SetRegister Set the value of a register Description SetRegister( deviceno, registerno, {Fixed,Float,_}:value, type=INT ) Directly sets the value of a register. Parameters deviceno Device number (1-40) registerno Which register to set value text/html 2020-08-18T22:11:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setsystemitem?rev=1597788687&do=diff SetSystemItem Change value of a given system parameter Description SetSystemItem( item, value ) Change the value of a given system parameter Parameters item The system item to set (see below) value The new value Parameter Description SYSITEM_GPSX text/html 2019-09-02T21:42:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/settickinterval?rev=1567460548&do=diff SetTickInterval Set the rate of the calls to @Tick. Description SetTickInterval( interval_ms ) This will change the rate of which the system triggers the @Tick event. Parameters interval_ms The interval between events. 50-10000ms. Return value text/html 2019-11-19T00:02:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/settimer?rev=1574121762&do=diff SetTimer Set a timer or interval Description SetTimer( timernumber, timeout, parameter=0, repeat=0 ) Set up a timer with a timeout (in milliseconds) and an optional user supplied parameter. There are four independent timers available to each script. text/html 2022-07-13T17:04:03+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/setval?rev=1657731843&do=diff SetVal Set value of a user-defined memory cell Description SetVal( address, value ) Set the value of one of the user defined memory cells. There are 512 32-bit cells available. The values are stored in NVM, so they will remain through power loss/reset. text/html 2020-08-15T00:12:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/sleep?rev=1597450365&do=diff sleep Pause script for a short duration Description sleep( milliseconds ) Pause the script for milliseconds. USE WITH CAUTION This command will prevent events to be executed and may cause unwanted delays in other logic. Parameters milliseconds text/html 2026-01-23T21:51:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/start?rev=1769205066&do=diff Script reference ezeio script programming - the PAWN language The scripting feature in the ezeio allows the user to implement advanced custom logic and control functionality on the ezeio. For most common applications, scripting is not necessary. text/html 2019-09-02T21:42:44+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strcat?rev=1567460564&do=diff strcat Concatenate strings Description strcat( dest[], const source[], maxlength=sizeof dest ) Copy the string source to the end of dest. Parameters dest destination string source string to be added to dest maxlength (optional) max total length of the result text/html 2019-09-02T21:42:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strcmp?rev=1567460577&do=diff strcmp Compare strings Description strcmp( const string1[], const string2[], bool:ignorecase=false, length=1024 ) Compare string1 and string2 Parameters string1 first string to be compared string2 second string to be compared ignorecase (optional) text/html 2019-09-02T21:43:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strcopy?rev=1567460593&do=diff strcopy Copy string Description strcmp( dest[], source[], maxlength=sizeof dest ) Copy the source string to dest. Parameters dest destination buffer source string to be copied maxlength (optional) maximum number of characters to copy Return value text/html 2019-09-02T21:43:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strdel?rev=1567460606&do=diff strdel Remove bytes from a string Description strdel( string[], start, end ) Remove some characters from a string Parameters string String to be manipulated start Position of first character to be removed end Position of last character to be removed. Must be after text/html 2019-09-02T21:43:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strfind?rev=1567460620&do=diff strfind Searches a string for a substring Description strfind( const string[], const sub[], bool:ignorecase=false, index=0 ) Search the haystack string for a needle sub. Optionally ignore case and start at an offset in the haystack. Parameters text/html 2019-09-02T21:43:54+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strformat?rev=1567460634&do=diff strformat Formats a string with placehoders Description strformat( dest[], size, bool:pack, const format[], {Fixed,Float,_}:... ) Formats a string with C-style printf placeholders. Possible placeholders are: * %d : integer number * %c : character text/html 2019-09-02T21:44:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strins?rev=1567460646&do=diff strins Insert a substring in a string Description strins( string[], const substr[], index, maxlength=sizeof string ) Inserts a substring into a string. Parameters string The string that will be manipulated substr The string that will be inserted text/html 2019-09-02T21:44:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strlen?rev=1567460657&do=diff strlen Find the lengths of a string Description strlen( const string[] ) Counts the number of characters in string, not including the terminating null. Parameters string The string that will be checked Return value Returns the number of characters in text/html 2019-09-02T21:44:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strmid?rev=1567460668&do=diff strmid Copy a subsection of a string Description strmid( dest[], const source[], start=0, end=cellmax, maxlength=sizeof dest ) Copy a subset of characters from source into dest. Parameters dest The buffer for the result source The string that we will extract data from text/html 2019-09-02T21:44:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strpack?rev=1567460681&do=diff strpack Create a packed copy of a string Description strpack( dest[], const source[], maxlength=sizeof dest ) This function copies a string from source to dest and stores the destination string in packed format. The source string may either be a packed or an unpacked string. text/html 2019-09-02T21:44:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strunpack?rev=1567460692&do=diff strunpack Create an unpacked copy of a string Description strunpack( dest[], const source[], maxlength=sizeof dest ) This function copies a string from source to dest and stores the destination string in unpacked format. The source string may either be a packed or an unpacked string. text/html 2024-02-05T23:20:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/strval?rev=1707175208&do=diff strval Find the numeric value of a string. Description strval( const string[], index=0, limit=15 ) strval will evaluate all digits starting at the index position until it encounters a non-digit or evaluated limit characters whichever comes first. text/html 2022-03-03T20:31:42+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/sunposition?rev=1646339502&do=diff SunPosition Helper function to calculate the sun's position at a given time and position on the earth. Description SunPosition( &Float:Elevation, &Float:Azimuth, Float:Lat, Float:Lng, time ) The function calculates the sun's position (Elevation & Azimuth) at the given lat/long coordinate at the given time. text/html 2025-07-10T18:21:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/updatedevicestatus?rev=1752171665&do=diff UpdateDeviceStatus Update the status of a given device Description UpdateDeviceStatus( deviceno, commStatus, opStatus, appStatus, signal, voltage, returnvalue=1 ) Updates the device status. Parameters deviceno Device number to request status from (or 0 for all devices) text/html 2019-09-02T21:45:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/uudecode?rev=1567460717&do=diff uudecode Decode an UU-encoded string Description uudecode( dest[], const source[], maxlength=sizeof dest ) Since the UU-encoding scheme is for binary data, the decoded data is always “packed”. The data is unlikely to be a string (the zero-terminator may not be present, or it may be in the middle of the data). text/html 2019-09-02T21:45:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/uuencode?rev=1567460729&do=diff uuencode Decode an UU-encoded string Description uuencode( dest[], const source[], maxlength=sizeof dest ) This function always creates a packed string. The string has a newline character at the end. Binary data is encoded in chunks of 45 bytes. To extract 45 bytes from an array with data, possibly from a byte-aligned address, you can use the function memcpy. text/html 2019-09-02T21:45:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://doc.eze.io/ezeio2/scriptref/valstr?rev=1567460740&do=diff valstr Convert an integer to a string Description valstr( dest[], value, bool:pack=true ) Parameter dest should be of sufficient size to hold the converted number. The function does not check this. Parameters dest The buffer that will hold the string