AMX I!-WEATHER Instruction Manual
AMX I!-WEATHER Instruction Manual

AMX I!-WEATHER Instruction Manual

Integration!solutions

Advertisement

Quick Links

instruction manual
i!-Weather
i n t e g ra t i o n ! S o l u t i o n s

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the I!-WEATHER and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for AMX I!-WEATHER

  • Page 1 ! S o l u t i o n s...
  • Page 2 CUSTOMER REMEDIES. AMX Corporation’s entire liability and your exclusive remedy shall be, at AMX Corporation's option, either (a) return of the price paid, or (b) repair or replacement of the SOFTWARE that does not meet AMX Cor- poration's Limited Warranty and which is returned to AMX Corporation. This Limited Warranty is void if failure of the SOFTWARE or hardware has resulted from accident, abuse, or misapplication.
  • Page 3: Table Of Contents

    Request New Weather Data ....................14 Receive New Weather Data....................15 Changing Temperature, Pressure, & Speed Formats............15 Channels ......................... 17 i!-Weather Virtual Channel Map ..................... 17 Request Channels........................17 Status & Request Channels ....................17 Debug Channels ........................17...
  • Page 4 Table of Contents Notification Channels ......................18 Status Only Channel ......................19 Commands........................19 i!-Weather Virtual Device SEND_COMMANDS ..............19 Examples ..........................20 Appendix A ....................... 1 Error Codes........................1 i!-Weather...
  • Page 5: Introduction

    Introduction Introduction i!-Weather™ is an application that allows you to retrieve and display current weather with 5-day forecasting from AMX’s weather provider. Current Weather Content: City name for current weather Current Heat Index Current Temperature Current Wind Chill Wind Direction...
  • Page 6: Installing I!-Weather

    3. The Welcome To i!-Weather Setup dialog appears, reminding you to close all Windows programs before going any further. Click Next to proceed. 4. In the Select i!-Weather Install Location dialog, use the Browse button to navigate to a directory other than the default install directory, if desired. Click Next.
  • Page 7: I!-Weather Engines

    Introduction i!-Weather Engines i!-Weather is comprised of the following: i!-WeatherEngineMod.tko: This i!-WeatherEngine module is provided to allow custom NetLinx programs to retrieve weather data in a structured programmable format. i!-WeatherEngineTest.axs: NetLinx sample code provided to demonstrate the usage of the i!-WeatherEngine module.
  • Page 8 Introduction i!-Weather...
  • Page 9: Using I!-Weather

    5. Select the desired city. This will display the Station ID used on the "Enter Station ID" page. This will also return you to the "i!-Weather Select Location" page and display it in the "current location" field. From this page you can save the location or return to the "Main Page".
  • Page 10: Saving Presets

    Next time a weather refresh occurs the units will be updated. Auto Refresh Interval Select To select an auto refresh interval: 1. Navigate to the "i!-Weather Select Location" Page. At the bottom-center of the page you will find the "Automatic Refresh" options. 2. Select desired auto refresh time interval.
  • Page 11: Programming I!-Weather

    Define Module The entire application functionality of i!-Weather is contained in the i!-WeatherApplicationMod.tko file. This file is distributed in a pre-compiled format. To include the module in a program, an instance of the module must be defined in the parent program.
  • Page 12 The device of an available IP port on the NetLinx Master for updating dvBROWSER_IP_CLIENT i!-Weather city lists. An available virtual device to be used exclusively for the i!-Weather Application. vdvWEATHER A device array for all touch panels sharing the i!-Weather system.
  • Page 13 • 1 - UPDATE CURRENT WEATHER DATA • 2 - UPDATE WEATHER DATA ZIP CODE • 3 - UPDATE WEATHER DATA BY STATION ID An integer array for i!-Weather Busy status (Channel Code). UI_WEATHER_BUSY_ INDICATOR • 1 - i!-Weather Busy Status...
  • Page 14 • 4 - Bottom of List • 2 - Page Down • 5 - Scrollbar • 3 - Top of List An integer array for the i!-Weather browse list fields (Var Text & Channel UI_LIST Codes). • 1 - List Column 1, Item 1 •...
  • Page 15: Devices

    = 33001:1:0 //VIRTUAL DEVICE Constants The following channels of the virtual device are the primary interface to i!-Weather. To set a format option or to request weather data, your NetLinx code will generate a push to the virtual weather device ( ).
  • Page 16: I!-Weatherenginetest.axs / I!-Weatherenginemod.tko

    Programming i!-Weather i!-WeatherEngineTest.axs / i!-WeatherEngineMod.tko To create a custom NetLinx application for use with i!-Weather, you will need to include the i!-WeatherEngine module in your program. The included i!-WeatherEngineTest.axs file demonstrates how to integrate the i!-WeatherEngine module into a program.
  • Page 17: Structures

    Structures The following structures contain all the detailed weather data elements retrieved by i!-WeatherEngine module. Any of these elements can be accessed by your program after weather data has been received and decoded. //i!-Weather DATA STRUCTURE STRUCTURE _sWEATHER //Location CHAR...
  • Page 18: Request New Weather Data

    An example is provided below: //----------------------------------------------------------------------- // i!-Weather Update Weather Data By Zip Code for: New York, New York. //----------------------------------------------------------------------- BUTTON_EVENT[dvTP,1] PUSH: //Set ZIP Code chZIPCODE = "'10101'"...
  • Page 19: Receive New Weather Data

    • Miles per hour (MPH) • Kilometers per hour (KPH) • Knots (KNOTS) A source code example is provided below to demonstrate how to set a particular format: //Set i!-Weather Temperature Format to i!-WeatherEngine DO_PUSH_TIMED(vdvWEATHER,VIRTUAL_CHANNEL_TEMP_FARENHEIT,5) //Set i!-Weather Speed Format DO_PUSH_TIMED(vdvWEATHER,VIRTUAL_CHANNEL_SPEED_MPH,5)
  • Page 20 Programming i!-Weather A source code example is provided below to demonstrate how to read a particular format: //Read i!-Weather Temperature Format from i!-WeatherEngine IF([vdvWEATHER,VIRTUAL_CHANNEL_TEMP_FARENHEIT]) nTEMP_FORMAT = TEMP_FARENHEIT IF([vdvWEATHER,VIRTUAL_CHANNEL_TEMP_CELSIUS]) nTEMP_FORMAT = TEMP_CELSIUS Weather data formats can also be changed via the virtual weather device command interface (Refer to the Commands section on page 19).
  • Page 21: Channels

    Programming i!-Weather Channels i!-Weather Virtual Channel Map //Request Channels (DO_PUSH) VIRTUAL_CHANNEL_QUERY_BY_ZIPCODE VIRTUAL_CHANNEL_QUERY_BY_STATION //Status & Request Channels VIRTUAL_CHANNEL_TEMP_FARENHEIT = 10 VIRTUAL_CHANNEL_TEMP_CELSIUS = 11 VIRTUAL_CHANNEL_SPEED_MPH = 13 VIRTUAL_CHANNEL_SPEED_KPH = 14 VIRTUAL_CHANNEL_SPEED_KNOTS = 15 VIRTUAL_CHANNEL_PRESSURE_INCHES = 17 VIRTUAL_CHANNEL_PRESSURE_TORR = 18 VIRTUAL_CHANNEL_PRESSURE_MILIBAR = 19...
  • Page 22: Notification Channels

    { vdvWEATHER,VIRTUAL_CHANNEL_ERROR_IP_CONNECT { vdvWEATHER,VIRTUAL_CHANNEL_ERROR_NOT_FOUND { vdvWEATHER,VIRTUAL_CHANNEL_ERROR { vdvWEATHER,VIRTUAL_CHANNEL_ERROR_LOGON_FAIL //---------------------------------------------------------------------------- // i!-Weather New Data Recevied----------------------------------------------- //---------------------------------------------------------------------------- //i!-Weather Engine Notified Us That New Data is Ready BUTTON_EVENT[vdvWEATHER,VIRTUAL_CHANNEL_SUCESS] PUSH: STACK_VAR VOLATILE SINTEGER siRESULT //DECODE NEW STRUCTURE DATA siRESULT = STRING_TO_VARIABLE(sWEATHER,chSTRUCTURE_ENCODED_BUFFER,1) //CHECK IN STRUCTURE TO SEE IF QUERY WAS SUCCESSFUL IF(sWEATHER.nQUERY_SUCCESSFUL)
  • Page 23: Status Only Channel

    Programming i!-Weather Status Only Channel The status of these i!-WeatherEngine virtual channels can be read, but are only set by the i!-WeatherEngine. Commands i!-Weather Virtual Device SEND_COMMANDS The following can be sent to the i!-WeatherEngine virtual device ( SEND_COMMANDS vdvWEATHER either in the NetLinx code or via a terminal session.
  • Page 24: Examples

    Programming i!-Weather Examples To retrieve New York’s weather by zip code: SEND_COMMAND vdvWEATHER," ’WEATHER BY ZIP-10101’ " To set the i!-WeatherEngine speed format to knots: SEND_COMMAND vdvWEATHER," ’SPEED-KNOTS’ " To request the i!-WeatherEngine’s temperature format: SEND_COMMAND vdvWEATHER," ’TEMPERATURE’ " The i!-WeatherEngine will respond by sending a...
  • Page 25: Error Codes

    The first byte in the Error Code detmines the error type. 'E' : Error - no not process weather data. 'I' : Informaion 'W' : Warning Additional textual information will also be returned to the MESSAGE field of the i!-Weather data structure. i!-Weather...
  • Page 26 Appendix A i!-Weather...
  • Page 27 Appendix A i!-Weather...
  • Page 28 DALLAS, TEXAS • LOS ANGELES, CALIFORNIA • MEXICO CITY, MEXICO • ONTARIO, CANADA • PHILADELPHIA, PENNSYLVANIA • SHANGHAI, CHINA • SINGAPORE • TAMPA, FLORIDA • WESTERLO, BELGIUM • YORK, ENGLAND 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com...

Table of Contents