manualshive.com logo in svg

Ezeio AAC, User Manual, Page: 78 / 121

Share
Download
Ezeio AAC User Manual Download Page 78

Set timer: 'timer' 

Use this API to set up an existing timer.

Parameter

Range

Description

timer

1 – 20

The timer number to set up

year (optional)

2000 – 3000

Year.  If not set, default is “any”.

month (optional)

1 – 12

Month.  If not set, default is “any”.

day (optional)

1 – 31

Day of the month.  If not set, default is “any”.

weekday (optional) 0 (Monday) – 6 (Sunday) Weekday. If not set, default is “any”.

hour

0 – 23 (24h format)

Hour – required 

minute

0 – 59

Minute - required

count (optional)

1 – 255

- Number of times the timer shall be executed.  
- Set to 255 to repeat forever. 
- Default is 1.

At a minimum, either hour/minute or count needs to be given for the 
command to be accepted.

Example, Trip timer 1 once, next Tuesday at 8:15pm

https://ezecontrol.com/api/control.php?timer=1&

weekday=2&hour=20&minute=15 

Example, Change the count without affecting the time setting:

https://ezecontrol.com/api/control.php?timer=1&count=5 

Page 78 of 121

Summary of Contents for AAC

Page 1: ...ezeio user manual Manual version 170314 ezeio models AAC AAF Page 1 of 121 ...

Page 2: ...e cover The ezeio is a low voltage device Never connect high voltage to the inputs or outputs MicroLAN Never use connectors or wires designed phone networks to connect MicroLAN devises Phone connectors usually alter the polarity and will permanently damage MicroLAN devices voiding the warranty SIM Card Cellular Antenna Always disconnect the power adapter from the ezeio when installing or removing ...

Page 3: ...ll need this information to communicate with the product When activating the unit you will also be assigned an account number Make a note of this important information below Account Number Serial Number Registration code Support contact information Go to www ezecontrol com for support and contact information Page 3 of 121 ...

Page 4: ...stalling the ezeio 11 ezeio overview 12 Power connection 13 Network connection 13 General purpose inputs 15 Inputs Pulse switch or resistive sensors 16 Inputs External voltage sources 17 Inputs Current sensors 18 Relay outputs 19 DC output terminal 19 MicroLAN 20 Modbus serial port 22 GSM 3G GPS module select models only 25 Web interface overview Logging in 29 Dashboard screen Dashboards 31 Status...

Page 5: ...Action ModBus write register 67 Account screen Account 68 Personal 68 Users 69 Sending control commands Email 70 Control via SMS cellphone texting 70 Control Commands 71 Server API API access and security 73 Live status in JSON format via REST API 75 Historical data access in JSON format via REST API 75 Controlling the ezeio via REST API 76 Spreadsheet integration 81 Automatic export push 83 Scrip...

Page 6: ...tions 111 System events 114 Specifications ezeio 117 Configuration and programming 118 Server Communication 118 Warranty Manufacturers warranty statement 119 Liability disclaimer 119 Standards compliance Applicable standards 120 Page 6 of 121 ...

Page 7: ...cations include Monitoring energy meters electrical water gas M V applications energy saving improvements Monitoring refrigeration systems temperature pressure Controlling monitoring HVAC systems thermostats room sensors Construction site monitoring cement curing heating cooling alarms Automating thermal energy storage systems TES Technical alarm systems fan monitors temperature tank levels Lighti...

Page 8: ...0ft but depends on wall material and other environmental factors GSM 3G GPS When configured with a built in GSM Cellular modem the ezeio can communicate with the Internet via cell service This requires service from a local cell provider and only GSM systems are supported The ezeio will use the physical Ethernet path if it is available but automatically switches to GSM if it can t communicate over ...

Page 9: ...fer to separate user access simply create unique accounts for each ezeio There is no per account cost but having a lot of accounts may become difficult to manage Creating a new account Go to www ezecontrol com Click Create a new account Step 1 The system will ask you for the ezeio serial number and the registration code These are printed on a sticker located on the front of your ezeio Enter them e...

Page 10: ...nk Then enter the ezeio serial number and registration code Then follow the rest of the sign up instructions The process is basically the same as creating a new account See page 9 This will automatically link the new user with your existing account and you will receive an email informing you that a new user has been added By default new users have minimal privileges You can log in and change the p...

Page 11: ...ter to power the ezeio Do not run wires that connects to the ezeio Inputs outputs MicroLAN Ethernet Modbus power or antenna together with high voltage wiring Use separate conduits whenever possible and avoid environments with excessive RF or magnetic radiation as this may interfere or even destroy the ezeio Take necessary precautions to avoid large static discharges to the ezeio connections MicroL...

Page 12: ...ezeio overview Page 12 of 121 ezeio external connectors Internal features SIM and antenna connectors only on GSM model Basic communication setup Antennas only on GSM model ...

Page 13: ...metal frame marked Ethernet NOT the Modbus jack All communication parameters are pre programmed in the ezeio so there is nothing to set up The ezeio will automatically contact the servers The ezeio automatically establishes IP information through DHCP Ensure your network connection supports DHCP and that the DHCP server provides valid gateway and DNS information For static IP setup see page 14 The...

Page 14: ...P network It can now be moved to the network that requires fixed IP Restoring DHCP functionality To restore DHCP support first remove the fixed IP settings on the server by blanking out the IP field and click Save Changes If the ezeio is still communicating via fixed IP the settings will be automatically synced and applied after the next reset of the ezeio If the ezeio is not communicating the res...

Page 15: ...d the input to 5V See pg 16 0 5VDC Input impedance is 70kOhm Raw reading is about 10000 at 5 0V 0 5mV per count See pg 17 0 10VDC Input impedance is 70kOhm Raw reading is about 10000 at 10 0V 1mV per count 0 30mA suitable for 4 20mA transducers An internal 100 Ohm resistor connects the input terminal to Common Raw reading is about 10000 at 30mA 3uA per count See pg 18 To access the input jumper se...

Page 16: ...0 volt terminal and one of the four input terminals like this If connecting to a pulse meter output please make sure the polarity matches the meter s The C terminal on the ezeio should be connected to the meter s minus or ground Three wire KYZ sensors Form C are read as two wire sensors Form A connect K to the ezeio s C terminal and Y to one of the ezeio inputs The ezeio input will detect pulses a...

Page 17: ...sor to the input between the C 0 volt terminal and the input as shown here The ezeio is designed for low voltage connections Never connect high voltage to the ezeio inputs A series resistor can be added to increase the range of an input Use a 100kOhm resistor to allow measuring up to 20V Use a 390kOhm resistor to allow measuring up to 50V Contact eze System if you need to measure higher voltage th...

Page 18: ... higher voltage is required for the current loop sensor either use a different adapter for the ezeio or feed the current loop from an external source like this The internal current sense resistor in the ezeio is 100Ω so the loop voltage drop at 20mA will be 2V U R I Check the data sheet for your current sensor and make sure the voltage source is at least 2V higher than the minimum voltage for your...

Page 19: ...e relay outputs are dry contacts If the load is inductive please apply appropriate protection such as spark inhibitor and or flyback diode DC output terminal The output terminal can be used to power external sensors or relays The voltage on this terminal is nominally 1V lower than the input voltage on the DC input jack The DC output can supply up to 200mA Page 19 of 121 0 10V 4 20mA Relays Inputs ...

Page 20: ... Meaning off No devices detected and no devices expected on Initializing fast flash Searching for new devices slow flash Devices configured expected but none communicating 2 flash Communicating but at least one device missing 1 flash Communicating with all devices Connecting a MicroLAN device To add a MicroLan device to the ezeio remove power from the ezeio connect the new sensor and power up the ...

Page 21: ... voiding the warranty RJ12 pin Signal Description 1 5V 5V DC out max 100mA 2 G Signal ground 3 Data 1 wire data bidirectional 4 G Signal ground 5 n c not connected 6 DC 8 25V DC out max 200mA MicroLAN extension cables Twisted pair cable such as Cat3 or Cat5 AWG22 24 is recommend to ensure signal quality Cables must be terminated with straight through pinout see diagram below Do not exceed 50m 150f...

Page 22: ... RJ45 Common nomenclature EIA TIA 485 name Description T568A B color 4 D1 D B B Data 1 V1 Voltage Blue 5 D0 D A A Data 0 V0 Voltage Blue white 7 VP 8 25V DC out max 200mA Brown white 8 Common C C Signal power supply common Brown This pin arrangement conforms to the Modbus specification 2W MODBUS see www modbus org Pins not listed above are not connected Standard Ethernet patch cables are suitable ...

Page 23: ... cases the device needs a separate power supply Refer to the device manual for details The ezeio needs to be configured with the device address to communicate with the new device Refer to Configuring Modbus Devices page 52 for details Always run the Common Ground wire to all devices on the bus Note that some devices have other markings for A B such as D0 D1 or Do not confuse bus with power termina...

Page 24: ...5 is a robust multi drop serial network This means that all the devices connected to the network communicate over the same pair of wires The signal rate is typically 19200 bits per second which is usually more than enough for the types of devices used in ezeio applications Modbus TCP IP use Ethernet hardware to connect the devices The data rate is much higher than on RS 485 but that also limits th...

Page 25: ... Ethernet connection is not usable the ezeio uses the cellular service to connect to the servers A valid SIM card with data service is required to use the GSM connection eze System can provice SIM and cellular service in some areas Contact us for details Always disconnect power from the ezeio when installing or removing SIM card or antennas Do not power up the ezeio without a cellular antenna conn...

Page 26: ...w data connectivity The ezeio will only use cellular data It does not use voice minutes or text messages Typical data usage for a full month is about 7 15 MB but may vary depending on how frequently logging data is captured and other configuration parameters Make sure the cellular antenna is connected in the connector to the right Do not use tools to tighten the antenna nut It only needs to be fin...

Page 27: ... to a working network before you insert the SIM card GSM Cellular indicator The GSM LED indicates the status of the cell radio as described in the table below Blink pattern Meaning off GSM radio is turned off on Waiting for the GSM module to switch on 5 on blink Attempting to initialize GSM module 4 on blink GSM module requested SIM PIN 3 on blink Module active Waiting for GPRS network 2 on blink ...

Page 28: ... antenna with a clear view of the sky The ezeio may need to be restarted to recognize the GPS antenna It may take a few minutes for the ezeio to find enough satellites and lock in an accurate position The GPS position will be available on the status page The GPS position is mapped as inputs on the ezeio as follows Input Description Input 7 GPS Latitude degrees 1 000 000 Input 8 GPS Longitude degre...

Page 29: ...view of all ezeio units on the account Status full live status of one ezeio at a time Configure settings for each ezeio unit Account account and user settings Access to the individual features on the web site is controlled by the user privilege settings and the service level of the ezeio For example the configuration tab is not visible for users with minimal privileges Access to the web page is se...

Page 30: ...information Right click the ezeio entry to access the drop down menu Flush Config will download all configuration into the ezeio unit This may be useful if a lot of configuration changes has been made to make sure all settings are aligned between the servers and the ezeio Reset Controller will cause the ezeio unit to reboot It does not change any configuration settings or logged data Page 30 of 12...

Page 31: ...rs with privilege to change account information can alter the Account view Each Dashboard consists of configurable blocks called widgets There are many widget types to choose from and each user may set up the widgets to his her liking Click on Add widget in the upper left of the screen and select from the options in the dialog box The widgets can be positioned on the Dashboard screen by dragging t...

Page 32: ...status is shown as a green dot if online with an Ethernet connection or a warning triangle if offline In addition to the green dot GSM equipped ezeios will show an antenna symbol and signal strength in green bars when they are connected by GSM Even if the ezeio is online it may take a few seconds for the status screen to refresh with live data Page 32 of 121 ...

Page 33: ... the wrench icon next to the counter The count value is stored in non volatile memory every 90 seconds and automatically restored on reset The Raw column shows the value from the hardware input before converting it to a real world unit The Alarms column shows the current status of the four possible alarm settings Hover the mouse cursor over the symbols to see their meaning Output status and contro...

Page 34: ...he leftmost column brings up a dialog box that allow for direct control over the demand response feature As of this printing the only supported thermostat is the T 32 P available from eze System Event log At the bottom of the screen the ezeio event log is shown Any recent events are temporarily highlighted Downloading log data Select the input or inputs to download data from by checking the boxes ...

Page 35: ...ote that the Area and Visible Area values really only make sense if the sensor used is a power or flow sensor Controlling the graph By hovering the mouse cursor over the graph information about each sample will be shown The graph window allows zooming by highlighting a section with the mouse drag from top left to bottom right or by using the mouse scroll wheel Reset zoom by dragging right to left ...

Page 36: ...ining this month and the number of API requests remaining for the current 24h interval Service settings If the service settings are not shown your account is managed by your installer reseller Please contact the person you purchased the ezeio from In the settings box you may select the level of service desired for this ezeio You may change the service level at any time and the system will automati...

Page 37: ...he page the resources of the ezeio are shown in a structured tree form The tree can be expanded by clicking the plus icons Click the name of each object to see more information on that object Click on an item on the list to view or modify Click on the Add link to create new items To commit changes simply click the Save changes button This will commit the changes to the database and also synchroniz...

Page 38: ... fit the data By default this is unchecked Max value in graphs The maximum value on the vertical scale in graphs Only relevant when autoscale is inactive Min value in graphs The minimum value on the vertical scale in graphs Only relevant when autoscale is inactive Display and Type Conversion settings only affect the way the data is displayed It does not change the raw stored data Input type The ty...

Page 39: ...d math expressions The input raw value is represented by a lower case x Unit to input Raw The math used to convert from the real world unit back to the raw input value This should be the inverse function of the Input Raw to Unit function Examples of inverse functions Input Raw to Unit Unit to Input Raw x 10 x 10 x 5 32 x 32 5 5000 x 5000 x Simply speaking if you take the output from the first func...

Page 40: ...nship is not linear Other devices may use other scaling on the inputs Consult the device manual for details Digital pulse input Normally the value of an input represents a voltage current or resistance If the sensor connected is of pulse type such as a S0 pulse the input can be defined as a Digital Pulse Input by enabling this check box When this box is checked the input value will reflect the tim...

Page 41: ... line needs to have a number a colon and a text following the colon You may enter multiple text status lines The numbers must be in increasing order The program will search the list from top to bottom order The first line with a number higher or equal to the current input value will be shown The text will be shown in the space for alarm status on the status screen and in the widget Live Input Alar...

Page 42: ...s or connected devices input values can be software driven The setting Special Software allows script external commands or API calls to set the value of the input Input locations for the ezeio Source Description Special Software Script or API call Input 1 ezeio Input 1 Input 2 ezeio Input 2 Input 3 ezeio Input 3 Input 4 ezeio Input 4 Input 5 Supply voltage DC Power supplied to ezeio Input 6 CPU co...

Page 43: ...stom These will open conversion helper dialog boxes useful for calibration The Use key will copy the math from the dialog into the Input Raw to Unit and Unit to input Raw conversion fields Don t forget to click Save Changes after using the Custom helper function Also see the section about calibration on the following page Page 43 of 121 ...

Page 44: ...ocedure is the same regardless of the type of sensor or unit 1 Connect the sensor to the ezeio or the expansion unit and make sure we get a reading of the sensor on the status page in the raw column Do not worry about setting up the correct type at this point We will only need the raw reading 2 Apply the first reference current to the sensor and let the sensor stabilize Current sensor and referenc...

Page 45: ...ut screen and select the input In the Input Type box select Custom Then click the Linear Analog link to open the Two point calibration dialog 5 In the dialog box enter the raw and reference value currents in the Point1 and Point2 fields as seen in the image above Click the Use button to apply the conversion to the input Don t forget to click Save Changes to finish The input is now calibrated Page ...

Page 46: ...ion to occur Threshold for restore The threshold where the alarm condition should clear Restore holdoff Delay in seconds The input value will need to exceed the threshold for this time interval for the alarm condition to clear If the alarm threshold is lower than the restore threshold the alarm function is reversed The alarm will activate when the input value is lower than the alarm threshold and ...

Page 47: ...ription See Page Send Message Send a message to email SMS voice call third party system and more 60 Log Event Record an event in the event log 66 Set Output Set or reset a local output 66 Set Counter Set a counter to some specific value 66 Increment Counter Count up a counter 66 Decrement Counter Count down a counter 66 Control Thermostat Adjust the set point or change operating mode of a thermost...

Page 48: ...ction will only execute if the referenced input value is less than a given value Input reference Value in real unit Input more than The action will only execute if the referenced input value is more than a given value Input reference Value in real unit Counter less than The action will only execute if the referenced input counter register is less than a given value Input reference Counter value Co...

Page 49: ...the output as long as the conditions selected are true see Conditions page 48 The settings for each output are Output name A user defined name for the output Output location This defines the hardware where the output is located One shot coil msg This setting only applies to modbus connected output devices If checked the set command will only be sent when the output status changes The default unche...

Page 50: ...erval exit For more information about actions see Actions page 47 Timers Timers are a simplified form of schedules Up to 20 timers are supported for each ezeio When a timer reaches its defined point in time it will run the defined actions up to four actions per timer and count down its recursion count Recurrence can be unlimited or set between 1 and 254 counts When the counter reaches zero the tim...

Page 51: ...ostat schedule All thermostats that are associated with schedules will be listed on the status page automatically where the current status of the thermostat will be shown Conditions for using alternate settings Associated thermostats will be switched to alternate mode if the conditions selected evaluate to true Other settings Stir The stir feature monitors the activity of each thermostat and will ...

Page 52: ...s address and communication settings All devices sharing the Modbus communication line needs to be set for the same speed and format The default is 19200 bps 8 data bits no parity Click the Devices root item in the configuration tree and then click Add Device In the dialog box select the type of device you are adding enter its address and click Add Device Devices listed have been tested for compat...

Page 53: ...is now added to the system and you can add inputs and outputs tied to the RF units Wireless Pairing After adding the device power up the wireless expander The signal LED will blink slow until the communication with the ezeio is established this may take up to 4 minutes Short 1 sec flashes indicate normal operation and communication with the ezeio A paired expansion unit will only communicate with ...

Page 54: ... programming of the ezeio Please contact eze System if you wish to use this feature If enabled a Script option will be displayed in the resource tree and an online script editor is made available Please refer to the section about the Script language starting on page 88 Page 54 of 121 ...

Page 55: ...e fields blank If they are used use strong passcodes and keep them safe Read passcode This code is used to authorize external access to data such as API functions and status requests The code needs to be at least three characters long to be accepted Only data retrieval is allowed with this code No changes to the system are possible To disable external access leave this field blank Control passcode...

Page 56: ...ur account The ezeio will be returned to an internal pool and be made accessible to other account holders for re registration provided they have the correct Registration code Note that all settings and the log history for the ezeio will be retained even if it s deleted To move a ezeio from one account to another the ezeio first has to be deleted in order to be available to add to the new account D...

Page 57: ... 84 Phone module PIN This should be set to the PIN code on the GSM module If the module does not have a PIN code programmed this field should be left blank SIM card PIN This should be set to the PIN code on the GSM SIM card If the card does not have a SIM PIN code programmed this field should be left blank GPRS APN login name password These fields need to be set to the APN login and password of th...

Page 58: ...xchanges If this checkbox is active a 50ms additional delay is added between packets Custom protocol This setting will disable the Modbus functionality completely and allow the user to write custom script functions for the communication on the serial port See the SerialSend fuction on page 110 Type of controller The hardware type of ezeio usually 1 Firmware version The ezeio firmware version Last ...

Page 59: ...local output 66 Set Counter Set an input counter register to some specific value 66 Increment Counter Count up an input counter register 66 Decrement Counter Count down an input counter register 66 Control Thermostat Adjust the set point or change operating mode of a thermostat 66 Modbus Coil Control Directly control a coil register on a connected Modbus device 67 Modbus Write Register Directly co...

Page 60: ...def456abc123def456abc123xy 64 Exosite exosite CIK ResourceID 64 Voice US 12125551234 Outside US 01161555512344 AU 64 Control API call to another ezeio Same account AAA 000 Different Account AAA 000 password 65 SMS recipients must begin with a plus and Country Code Voice recipients outside the USA must begin with 011 Country Code You may combine destinations by separating them with commas or semico...

Page 61: ...ameters Parameter Description VALx Inserts the converted momentary value of input with number x CNTx Inserts the counter register value of input number x OUTx Inserts the current state on or off of output number x SCHx Inserts the current state active or inactive of schedule x STAx Inserts the translated input value text from the Text Status box under input settings Example of a message using refe...

Page 62: ...g the email subject When sending emails the subject field defaults to the text ALARM or RESTORE followed by the name of the resource that caused the alarm and the alarm name By inserting a vertical line character in the message the subject line will be replaced with the text before the and the message body will be the text after the Example This is my subject This is the body text SMS Text To send...

Page 63: ...on update twitter account description Twitter account messages should not be considered reliable alarm paths HTTP POST To send a HTTP POST enter the URL of the server starting with http or https The message will be sent with the following POST fields POST Field Name Description serial ezeio serial number controllername ezeio name controllerlocation ezeio location source Source of the alarm System ...

Page 64: ... The ezeio can send messages to the Exosite web services Enter the destination like this exosite CIK ResourceID The value is set to the content of your message See http exosite com for more information Voice To dial a phone number and send a voice message simply enter the telephone number in the Destination field To enter multiple recipients separate the telephone numbers with a comma Each number ...

Page 65: ...mote ezeio is on a different account enter a colon followed by the control password the control password is located system In the message box enter the desired parameters separated by comma See the REST control API section page 68 for more information Example to turn on output 2 for 10 seconds on ezeio XYZ 987 Destination XYZ 987 secretpass Message output 2 cadence 1 duration 100 Note that the eze...

Page 66: ... state Action Set counter This action will set the Count register on the referenced input to a specific value Action Increment counter This increments the Count register on the referenced input Action Decrement counter This decrements the Count register on the referenced input Action Control thermostat If T32P thermostats are connected to your ezeio the control thermostat action allows you to over...

Page 67: ...ntrol This action allows you turn on or off a the coil of a selected ModBus device Action ModBus write register This action allows you to write a value to a specific write register of a selected ModBus device Page 67 of 121 ...

Page 68: ...an ezeio on this account fails restores contact with the server or when an ezeio changes from communicating over Ethernet to GSM and back Copies of these emails are also sent to the ezeio system info address see page 55 Account status By checking the Accept New Users checkbox new users can register with the account provided they have a ezeio serial number and registration code of an ezeio that is ...

Page 69: ... his her password the administrator may assign a new password but the old password cannot be retrieved Log in This check box must be checked to allow the user to log in Edit own info This check box allow the user to change the information under the Personal tab Edit controllers This check box allows the user access to the Config tab Remote control Check this box to allow the user to control output...

Page 70: ...or as communication command syntax or invalid ezeio ID or password Control via SMS cellphone texting Just as the ezeio can be controlled through email SMS Short Message Service can also be used The message should be sent to Region Access number US Canada 1 916 281 9001 United Kingdom Ireland 44 7937 985 875 Sweden 46 769 439 907 Australia New Zealand 61 448 838 189 Any other region 44 7937 985 875...

Page 71: ...Standard Run ADJUST Adjust a thermostat Degrees minutes If minutes is not given 1h is default The system will reply to confirm the command was understood Examples output warehouse lights on turn on the output named warehouse lights out warehouse lights on 20s output can be abbreviated 20s means it will be on for 20 seconds timer sauna 18 00 trip the timer named sauna at 6pm once timer sauna 6 15pm...

Page 72: ...Page 72 of 121 ...

Page 73: ... through HTTP since the communication in this case will be sent unencrypted If at all possible use HTTPS for API access In order to use the API features the ezeio must have a service level that includes enough API calls for the specific application Click the Configure tab to set an appropriate service level for each ezeio Page 73 of 121 ...

Page 74: ...of how to call the log php API from PHP code php url https ezecontrol com api log php API URL serial XYZ987 ezeio serial pass supersecret Read passcode fields array input 4 input 4 from 2010 08 22 start time to 2010 08 24 end time ch curl_init url curl_setopt ch CURLOPT_RETURNTRANSFER 1 curl_setopt ch CURLOPT_HTTPAUTH CURLAUTH_DIGEST curl_setopt ch CURLOPT_USERPWD serial pass curl_setopt ch CURLOP...

Page 75: ... the ezeio useful if ezeio is on cellular The cache is updated roughly every minute while ezeio is on a physical connection and every 10 minutes while on cellular Example https ezecontrol com api status php logid 4821349 Historical data access in JSON format via REST API This API call will return historical data related to a given input https ezecontrol com api log php The password needs to be the...

Page 76: ...ut Use this command to directly control the output state Parameter Range Description output 1 40 The number of the output to control cadence 0 7 see below The cadence to apply duration 0 1 65535 Number of 1 10th seconds to run this cadence before turning the output off again 0 infinite Example turn on output 1 for 2 seconds https ezecontrol com api control php output 1 cadence 1 duration 20 Cadenc...

Page 77: ...t the counter value on input 5 to 12345 https ezecontrol com api control php counter 5 value 12345 Set input value input Use this command to change the value of one raw input value Parameter Range Description input Min 1 character The name of the input value 2 31 2 31 The new raw value of the input Example set the counter value on input 5 to 12345 https ezecontrol com api control php input 5 value...

Page 78: ...If not set default is any hour 0 23 24h format Hour required minute 0 59 Minute required count optional 1 255 Number of times the timer shall be executed Set to 255 to repeat forever Default is 1 At a minimum either hour minute or count needs to be given for the command to be accepted Example Trip timer 1 once next Tuesday at 8 15pm https ezecontrol com api control php timer 1 weekday 2 hour 20 mi...

Page 79: ...isable to 1439 Number of minutes the system will use the adjHeat adjCool settings before it returns to normal proramming setLock ON OFF If set to ON the keypad is locked and will not accept any user input setScheduleMode AUTO STANDARD ALTERNATE Force the thermostat to use either the standard or the alternate settings from the controlling thermostat schedule This overrides the condition setting in ...

Page 80: ...he interval start times to the same value and make sure the start times are sorted altHeat 150 400 1 10 Celcius 500 950 1 10 Farenheit Heating setpoint in 1 10th degrees so 745 74 5 F alternate schedule mode altCool 150 450 1 10 Celcius 460 990 1 10 Farenheit Cooling setpoint alternate schedule mode altSysMode OFF HEAT COOL AUTO System mode alternate schedule mode altFanMode OFF AUTO ON Fan mode a...

Page 81: ...on may differ In Excel select Data From Web then enter the following URL in the browser window https ezecontrol com api inputsnapshot php ser SERIAL pw PASSWORD replace SERIAL and PASSWORD accordingly The password is the Read Passcode from Configure System Click Go The window will populate with data from your ezeio Click one of the yellow arrows to select the table and then Import to insert it in ...

Page 82: ...ntroller data in the URL of External Data Source field using the format below and press Enter https ezecontrol com api inputsnapshot php ser SERIAL pw PASSWORD replace SERIAL and PASSWORD accordingly The password is the Read Passcode from Configure System Select the HTML_LiveInputStatus item list and click OK to insert the data into your spreadsheet Page 82 of 121 ...

Page 83: ...eters field is not used for JSON push The system will start exporting data as soon as the configuration is saved The export process runs every 3 minutes and is not adjustable JSON push schema The message sent to the remote server has the following structure ser ezeio serial inp name of the input in the ezeio config pid ID of the input as set by the Point ID field unit the unit of the input salt ra...

Page 84: ...ADPASS verysecretpasscode json file_get_contents php input if isset _SERVER HTTP_X_HASH die ERROR Missing hash if md5 json READPASS _SERVER HTTP_X_HASH die ERROR Hash mismatch if data json_decode json true NULL die ERROR Invalid payload foreach data data as sample process the sample here lastprocessed sample time return the timestamp of the last processed sample r array result lastprocessed print ...

Page 85: ...yStar provides a free service called Portfolio Manager designed for property managers to track and benchmark energy usage To use the EnergyStar system you need to create an account at https portfoliomanager energystar gov pm login html Make sure the meters you want to upload to are shared and allowed to Exchange Data Find the meter ID by going to the Edit Basic Meter Information page The last numb...

Page 86: ... is a IoT dashboard SaaS provider It is primarily suitable for resellers that want to customize and brand the user interface for their clients To use Exosite you have to create an account at http exosite com and create the Devices and Data points you want to use Each device in the Exosite system will be assigned a CIK code and each data point will have a RID code You will need to enter both these ...

Page 87: ...ETER123 13184 2014 02 19 11 METER123 13184 2014 02 19 12 METER123 13185 2014 02 19 13 METER123 13187 2014 02 19 14 METER123 13187 2014 02 19 15 METER123 13188 2014 02 19 16 METER123 13189 2014 02 19 17 METER123 13190 2014 02 19 18 METER123 13191 2014 02 19 19 METER123 13193 2014 02 19 20 METER123 13194 2014 02 19 21 METER123 13195 2014 02 19 22 METER123 13196 2014 02 19 23 METER123 13198 2014 02 1...

Page 88: ...not enough to learn how to program from scratch You will need prior knowledge related to software development to be able to use the ezeio scripting efficiently If you have any prior experience with JavaScript C Java Perl or similar languages PAWN will look very familiar to you and looking at our examples in this manual should get you going quickly eze System offers programming services on hourly b...

Page 89: ... and the output set according to the result of the comparison of the inputs Processing the whole condition will be very quick less than a millisecond so there will be plenty of time for other things to happen in your script String handling The PAWN language defines strings as being either packed or unpacked The ezeio supports only packed strings meaning that each character is stored in a single by...

Page 90: ...te inputno 94 GetScheduleState scheduleno 95 GetSystemStatus item 95 Calendar and time functions GetSecond 96 GetMinute 96 GetHour 96 GetDay 96 GetMonth 96 GetYear 96 GetWeekday 96 SetTimer timerno timeoutms repeat 97 Mathematical functions Float fabs Float value 98 fround Float value method 98 Float ffract Float value 98 Float fsqrt Float value 98 Float flog Float value Float base 98 Float fpow F...

Page 91: ...index length maxlength 106 strformat dest maxlen format 107 Communication functions PDebug format 108 ExtAPICall wParam lParam format 108 ModbusSend address command length data 109 getThermostat channel address register 109 setThermostat channel address register value lock 110 SerialSend length data 110 Library functions GetTime time time_s UTC false 111 Linfit Float x Float y ndata Float a Float ...

Page 92: ...35 optional Defaults to 0 infinite Number of 1 10th seconds to run the cadence When the cutoff time expires the output will be turned off This function does not return a value Example Turn on output 2 for 10 seconds SetOutput 2 1 100 cutoff 100 is 10 seconds GetOutputState outputno Read the current status of an output Parameter Range Description outputno 1 40 required Which output to check The ret...

Page 93: ...iable in2mV GetInputValue 2 Example Read the value from a microlan temperature sensor on input 5 as 1 10th C Celcius 10 GetInputValue 5 16 55 Example Read the value from a microlan temperature sensor on input 1 as F F 100 GetInputValue 1 888 67 Example Read power as kW from a pulse meter with 500 pulses per kWh kW 7200 GetInputValue 8 SetInputValue inputno newvalue Set an input raw value to the sp...

Page 94: ...required Which input to set newcount 0 2147483647 required New value of the counter This function does not return a value Example Set the counter of input 5 to 456 SetInputCount 5 456 GetInputState inputno Reads the current alarm state from the input Parameter Range Description inputno 1 40 required Which input to read from The return value is a bitmap with four bits indicating the status of each ...

Page 95: ...PS antenna sysGPSElev GPS Elevation x 1 000 000 Only valid with 3G module and GPS antenna sysMLOK 1 if any Microlan devices are detected 0 if not sysEthOK 1 if a physical Ethernet connection is detected 0 if not sysRFOK 1 if a short range radio is detected 0 if not sysGSMAvail 1 if GSM 3G modem is detected 0 if no modem sysGSMSIMOK 1 if the SIM card is detected 0 if not sysGSMOK 1 if the GSM modem...

Page 96: ...he range 0 23 GetDay Return the current day of the month from the real time clock This function does not have any parameters The return value is the current day in the range 1 31 GetMonth Return the current month from the real time clock This function does not have any parameters The return value is the current month in the range 1 12 GetYear Return the current year from the real time clock This f...

Page 97: ...mitted the function will use the first timer that is not running timeoutms 0 or 1 to 2147483647 required Number of milliseconds before generating the Timer event If this parameter is 0 the timer will be cancelled and the Timer event will not be generated repeat 0 1 optional If set to 1 the timer will automatically reset and trip again Defaults to 0 Returns the timer number that was set or 0 if no ...

Page 98: ...ero round down for positive values round up of negative values Returns the value rounded off as an integer Float ffract Float value Return the fractional part of a number Parameter Description value The value to return the fractional part of Returns the fractional part of value Example ffract 3 14 returns 0 14 Float fsqrt Float value Return the square root of a value Parameter Description value Th...

Page 99: ...turn the tangent of a value Parameter Description value The value to calculate tangent of Float fasin Float value Return the reverse sine of a value Parameter Description value The value to calculate reverse sine of Float facos Float value Return the reverse cosine of a value Parameter Description value The value to calculate reverse cosine of Float fatan Float value Return the reverse tangent of ...

Page 100: ...o larger than max Parameter Description value The value to clamp min The smallest value to return max The largest value to return float2cell Float value Return the Float value as a cell using binary conversion not converting it through its value but just copying the bits This is useful in communication functions when parsing binary buffers containing float values Parameter Description value The fl...

Page 101: ...ns 0 if there was an error Example new a 5 45 23 89 3 7 qsort 5 a fqsort count Float data Sorts the array of float values in ascending order Parameter Description count The number of values in the array min 2 max 500 Float data Array of float cell values to be sorted Returns 1 if successful Returns 0 if there was an error Example new Float a 5 4 5 23 3456 0 89 3 3 77 7 fqsort 5 a Page 101 of 121 ...

Page 102: ... Parameter Description argumentno The argument number to return index optional If the argument is an array this is the index in the array default to 0 Returns the value of the argument setarg argumentno index value Set an argument value Parameter Description argumentno The argument number to return index optional If the argument is an array this is the index in the array default to 0 value The new...

Page 103: ...ter Description character The character to convert to uppercase strlen string Return the length of a string Parameter Description string The string to compute the length of strcopy dest const source maxlength Copy one string to a buffer Parameter Description dest Destination buffer source The string that will be copied maxlength optional The max number of characters to copy defaults to the length ...

Page 104: ...h Concatenate two strings Parameter Description dest The first part and the destination buffer source The part that will be added to dest Maxlength optional The maximum length of the destination buffer defaults to max size of dest Returns the length of dest after concatenation strdel string start end Remove a numbet of characters from a string Parameter Description string The string to work on sta...

Page 105: ...uffer to work on src The string to insert into dest index The position in dest where the src buffer will be inserted maxlength The maxumum permitted length of dest strmid dest source start end maxlength Copy a section of one string to a buffer Parameter Description dest The destination buffer src The source string start optional The position of the first character in source to copy Defaults to 0 e...

Page 106: ...st The destination buffer value The integer value to convert to text Returns the number of characters stored in dest excluding the teminating 0 memcpy dest source index length maxlength Copy bytes from one buffer to another Parameter Description dest The destination buffer source The source buffer index The position in the source buffer from which to start copying length The number of bytes to cop...

Page 107: ...laceholders The following placeholders are supported c a single character d an integer x an integer presented as lowercase hex X an integer presented as uppercase hex f a rational floating point number s a string Placeholders can be formatted with a number immediately following the sign The number indicates the field width in characters and will add spaces if needed To pad with zeros instead enter...

Page 108: ...format Generate an external call to a public server Parameter Description wParam User defined 16 bit parameter lParam User defined 32 bit parameter format String with optional placeholders Zero or more values to insert in the placeholders This function requires a working server link and an active account with available API service Each use of this function counts as one API call The parameters wil...

Page 109: ...tatus of a single thermostat Parameter Description channel The communication port where the thermostat is connected One of MICROLAN MODBUS LOCALRF Note currently only MODBUS is supported address The bus address of the thermostat register The thermostat register to retrieve One of setHeat Current heating setpoint 1 10th degrees setCool Current cooling setpoint 1 10th degrees adjHeat Heating setpoin...

Page 110: ...o heat cool FanMode 0 auto 1 on lock Boolean to determine if the change should lock the thermostat from user input false leave thermostat open to user input true lock thermostat screen This function do not return a value SerialSend length data Send data on the serial port Note that the port needs to be in Custom protocol mode See page 58 Parameter Description length The number of bytes to be sent ...

Page 111: ... returned Parameter Description time time_s Structure for date and time with the following properties ti_year ti_month ti_day ti_hour ti_minute ti_second ti_wday UTC optional Flag true or false If set to true the returned time is UTC time instead of local time Example usage new t time_s GetTime t PDebug Time d d d t ti_hour t ti_minute t ti_second Linfit Float x Float y ndata Float a Float b This ...

Page 112: ...ngitude of observation point in degrees from Greenwich meridian Positive numbers are east elevation The function will set this variable with the elevation of the sun above the horizon in degrees Negative numbers mean that the sun is below the equator azimuth The function will set this variable with the azimuth of the sun in degrees 0 is north 90 is east 180 is south and 270 is west Example usage n...

Page 113: ...N6 new Float T GetInputValue 6 8 8888 67 0 Read RH in percent from MicroLan sensor on IN7 new Float RH GetInputValue 7 5000 0 0 16 0 0062 Calculate Dewpoint in F new Float DP Dewpoint RH 100 0 T 1 Put result in IN13 SetInputValue 13 fround DP 100 0 Float Enthalpy Float Alt Float RH Float Temp BTU false This function calculates the energy content in moist air Parameter Description Alt Altitude in m...

Page 114: ...IMER 3 source is a timer sourceid Indicates the source index e g the input number 1 40 schedule number 1 20 or timer number 1 20 alarmno Indicates the alarm number 1 4 Restore sourcetype sourceid alarmno The Restore function is called each time a restore event is generated from the configuration The function is called even if there are no actions configured and regardless of conditions on any exis...

Page 115: ...ay data A byte array with the received data as it was received over ModBus Note that the array starts with the byte after the command byte The max number of bytes that can be received in one call is 20 Example mbReadReg deviceadr regno regcount new b 4 char regno regno 10000 1 Modbus address mapping b 0 regno 8 0xFF Build command buffer b 1 regno 0xFF b 2 regcount 8 0xFF b 3 regcount 0xFF ModbusSe...

Page 116: ... serial port A packet is considered complete when there is at least five byte times of no data after any byte s Note that this only applies when the serial port is is Custom Protocol mode see page 58 Parameter Description length The number of bytes received data A buffer that holds the data Page 116 of 121 ...

Page 117: ...onnections Form C 1 pole switching Max 2A 50V load Other connections Ethernet TP 10 100 RJ45 MicroLAN RJ12 Serial RS485 RJ45 jack GSM antenna SMA optional Expandability Up to 40 sensor inputs total Up to 40 outputs total MicroLan Max 20 MicroLAN devices supported Active pullup on data wire 5V and raw DC provided RJ12 jack compliant to Dallas connector standard Max 50m 150ft network length DC outpu...

Page 118: ...k Up to four actions for each schedule on entry exit of an interval Timers Up to 20 timers each can be set to repeat hourly daily weekly or monthly Each timer can trip up to four actions Scripts optional Up to 64kB compiled script code with 6kB of RAM Extensive function library with support for floating point math string manipulation and communication functions Server Communication Configuration A...

Page 119: ...ase consult with a qualified dealer installer before placing the product in service Installation and use of the product must comply with local laws and regulations The end user of the products acknowledges risks and waives any and all claims against eze System Inc and any of its agents eze System is not responsible for any applications of its products or the suitability of its products for any app...

Page 120: ...is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help ezeio W and ezeio GW models contain F...

Page 121: ...1 UK Global 44 7937 985 875 SE 46 769 439 907 AU 61 448 838 189 ezeioezeio serial password command Visit the eze System Inc website at www ezesys com The eze trademark ezeio and the eze system design are property of eze System Inc Any other trademarks referenced are properties of their respective owner eze System Inc 2008 2017 www ezesys com Page 121 of 121 ...

Reviews:

No comments