User manual AMX I!-WEATHER

[. . . ] instruction manual i!-Weather i n t e g ra t i o n !S o l u t i o n s Software Warranty Agreement GRANT OF LICENSE. AMX Corporation grants to you the right to use the enclosed i!-Weather software program (the SOFTWARE) on a single central processing unit (CPU). This license is for object code only and does not convey any rights to use of the source code. [. . . ] In the i!-Weather Shortcut Creation dialog, select Install Shortcut Icons for the installed components on your desktop, if desired. Click Next in the Start i!-Weather Installation dialog to install the selected components. The program prompts you to restart your system to complete the installation. i!-Weather NetLinx Components i!-Weather Applications i!-Weather is comprised of the following applications: i!-WeatherApplicationMod. tko: The i!-WeatherApplication module is the fully developed NetLinx application for retrieving detailed weather data from a given location. i!-WeatherApplicationTest. axs: NetLinx sample code provided to demonstrate the proper implementation and usage of the i!-WeatherApplication module. Navigate to the "i!-Weather Select Location" page. Select either Browse International or Browse US. 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". From time to time the browsable list of cities may become outdated, or new cities may come online. It may be necessary to update these lists. Navigate to the "i!-Weather Select Location" page. Select Start Download to begin downloading the files. Upon completion of download select Close. i!-Weather 5 Using i!-Weather Saving Presets After you have selected a location, it is retrieved immediately. On the "Select Location" Page, select Save. The selected preset will now display the city, state / city, country. If you select a previously used preset while save is flashing, it will be overwritten. Changing Temperature Units To change temperature units: 1. Navigate to the "i!-Weather Select Location" page. Next time a weather refresh occurs the units will be updated. Changing Wind Speed Units To change wind speed units: 1. Navigate to the "i!-Weather Select Location" page. Select MPH (Miles Per Hour), KPH (Kilometers Per Hour) or Knots. Next time a weather refresh occurs the units will be updated. Changing Pressure Units To change pressure units: 1. Navigate to the "i!-Weather Select Location" page. [. . . ] A character buffer that contains the current station code to retrieve weather data. A character buffer that contains the encoded weather data structure. Devices Make sure the device IDs are correct in the DEFINE_DEVICE section: //i!-Weather Devices dvWEATHER_IP_CLIENT dvTP dvBROWSER_IP_CLIENT vdvWEATHER = = = = 0:4:0 128:1:0 0:5:0 33001:1:0 //INTERNET CONNECTION //i!-Weather Touch Panel //INTERNET CONNECTION FOR CITY BROWSER //VIRTUAL DEVICE 12 i!-Weather Programming i!-Weather 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 cREPORTING_STATE[20] CHAR cREPORTING_CITY[100] CHAR cCELL[10] CHAR cZIPCODE[5] CHAR cCITY[100] CHAR cSTATE[20] CHAR cSTATION[10] CHAR cSUNRISE[15] CHAR cSUNSET[15] //Weather Data CHAR cLAST_UPDATE[20] CHAR cLAST_UPD_DATE[15] CHAR cLAST_UPD_TIME[15] CHAR cTEMP[10] SINTEGER nTEMP CHAR cHUMIDITY[10] INTEGER nHUMIDITY CHAR cHEAT_INDEX[10] SINTEGER nHEAT_INDEX CHAR cWIND_CHILL[10] SINTEGER nWIND_CHILL CHAR cDEW_POINT[10] SINTEGER nDEW_POINT CHAR cWIND_DIRECTION[20] INTEGER nWIND_DIRECTION CHAR cWIND_SPEED[15] INTEGER nWIND_SPEED CHAR cBAROMETER[20] FLOAT fBAROMETER CHAR cCONDITION[20] INTEGER nCONDITION //Forecasting CHAR cFORECAST_DATE[20] CHAR cFC_HI[5][10] SINTEGER nFC_HI[5] CHAR cFC_LO[5][10] SINTEGER nFC_LO[5] CHAR cFC_CONDITION[5][15] INTEGER nFC_CONDITION[5] CHAR cFC_DATE[5][15] INTEGER nFC_DAY_OF_WEEK[5] CHAR cFC_DAY_OF_WEEK[5][10] //Weather Data Reporting State //Weather Data Reporting City //Cell //Weather Zip Code //Weather City //Weather State //Weather Station //Sunrise Time (In GMT) //Sunset Time (In GMT) //Last Date & Time of Current Weather Update (In GMT) //Last Date of Current Weather Update //Last Time of Current Weather Update (In GMT) //Current Temp String //Current Temp Value //Current Humidity String //Current Humidity Value //Current Heat Index String //Current Heat Index Value //Current Wind Chill String //Current Wind Chill Value //Current Dew Point String //Current Dew Point Value //Current Wind Direction String //Current Wind Direction Value //Current Wind Speed String //Current Wind Speed Value //Current Barometric Pressure String //Current Barometric Pressure Value //Current Condition String //Current Condition Value //Forecast //Forecast //Forecast //Forecast //Forecast //Forecast //Forecast //Forecast //Forecast //Forecast Start Date Day Hi Temp String Day Hi Temp Value Day Lo Temp String Day Lo Temp Value Day Condition String Day Condition Value Day Date Day Day of Week Index Day Day of Week String //General INTEGER nQUERY_SUCCESSFUL //Query Success or Fail CHAR cBUFFER[65000] //XML Buffer CHAR cGETZIPCODE[5] //ZIP Code to query for CHAR cGETSTATION[10] //STATION Code to query for INTEGER nQUERY_METHOD //Query Weather Method CHAR cLAST_QUERY_DATE[15] //Last date weather was queried CHAR cLAST_QUERY_TIME[15] //Last time weather was queried (In NetLinx Time) INTEGER bDEMO_MODE //Data Received is in Demo Mode INTEGER nMESSAGE_TYPE //Message Type received in weather packet CHAR cMESSAGE[250] //Message Text received in weather packet INTEGER nDAYS_REMAINING //Days in weather service subscription remaining CHAR cERROR_CODE[3] //Error Codes } i!-Weather 13 Programming i!-Weather Request New Weather Data To request new weather data, your program simply needs to specify the zip code or station code, and then generate a PUSH notification on the virtual weather device (vdvWEATHER). The i!-WeatherEngine module receives the request notification, attempts to connect the weather provider, and gets new weather data. [. . . ]