WebHMI Docs

The GetForecastWeather function returns the weather forecast at the WebHMI installation location to the specified interval. The data is updated approximately every two hours. The service requires an Internet connection, an account in Level2 and a subscription to the weather forecast. The function is available since version 2.5.2400.

If for some reason the data has not been received, the value nil will be returned.

The interval is a three-hour time interval in the future. From zero to 6. Total six intervals. Zero interval is the forecast in about 3 hours. The first interval is the forecast in six hours. Etc. The format of the returned data is identical to the function GetCurrentWeather.

An example of a simple program that turns on and off the warm floor before entering the store, depending on the weather conditions.

function main (userId)
    local current = GetCurrentWeather();
    local nextForecast = GetForecastWeather(0);
 
    if (nextForecast.temperature > 6 and current.temperature > 6) then -- positive temperature
        WriteReg(91, 0); -- turn anti-ice off 
    end
 
    if (current.snow < 1 and nextForecast.snow < 1) then -- not snowing 
        WriteReg(91, 0); -- turn anti-ice off
    end
 
    if (current.cloudness < 20 and nextForecast.cloudness < 20) then -- clear
        WriteReg(91, 0); -- turn anti-ice
    end
 
    if (current.snow > 2 or nextForecast.snow > 2) then -- it's snowing
        WriteReg(91, 1); -- turn anti-ice on
    end
end

The function GetSunriseTime returns the time in the format Unixtime of the sunrise in the current day. The service requires an Internet connection, an account in Level2 and a subscription to the weather forecast. The function is available since version 2.5.2400. If for some reason the data has not been received, the value nil will be returned.

The function GetSunsetTime returns the time in Unixtime format of sunset in the current day. The service requires an Internet connection, an account in Level2 and a subscription to the weather forecast. The function is available since version 2.5.2400. If for some reason the data has not been received, the value nil will be returned.

The GetMeterConsumption function returns the resource consumption for the specified counter. Parameters variable_name and connection_name work in the same way as in the function GetReg - they determine the register with the resource counter. Since version 3.2 there is no more connection_name parameter.

Returned consumption of resources is the consumption of the meter for each hour from the beginning of the month to the current moment. Data is taken from Level2 times per hour. Why not from the local database? Because a) the data storage period on the SD card can be less than 1 month and b) because the SD card may fail and if it is replaced in the middle of the month, the data will be unreliable.

The service requires an Internet connection, an account in Level2, and an active data storage service. The function is available since version 2.9.

If for some reason the data has not been received, the value nil will be returned.

The GetResourceLimit function returns the limit of the specified resource for the current month. Limits are set in the Level2 system.

Possible resources names are: “ELECTRICITY”, “GAS”, “HEAT”, “WATER”, “HOTWATER”, “CUSTOM”

Data is taken from Level2. Data on WebHMI is usually updated no later than 1 hour after they are updated in Level2. If there is no connection, the system will return the limits from the cache. The cache stores the limits for the current and the next two months.

The service requires an Internet connection, an account in Level2. The function is available since version 2.9.

If for some reason the data has not been received, the value nil will be returned.

The GetTodayDayType function returns the type of the current day: work, holiday, holiday. The types of days are set in the Level2 system.

Three types are valid: “Working”, “Weekend”, “Holiday”.

Data is taken from Level2. Data on WebHMI is usually updated no later than 1 hour after they are updated in Level2. If there is no connection, the system will return the limits from the cache. The cache stores the limits for the current and the next two months.

The service requires an Internet connection, an account in Level2. The function is available since version 2.9.

If for some reason the data has not been received, the value nil will be returned.

The GetTomorrowDayType function is completely analogous to GetTodayDayType with the only difference that it returns data about the future.

GetHolidaysStats returns a table with the following fields:

• currentMonthDays – number of days in the current month
• nextMonthDays - number of days in the next month
• currentMonthWeekends - the number of dayoffs (according to the settings in the Level2 system) in the current month
• nextMonthWeekends - the number of dayoffs (according to the settings in the Level2 system) in the next month
• currentMonthHolidays - number of holidays (according to the settings in the Level2 system) in the current month
• nextMonthHolidays - number of holidays (according to the settings in the Level2 system) in the next month

Data is taken from Level2. Data on WebHMI is usually updated no later than 1 hour after they are updated in Level2. If there is no connection, the system will return the limits from the cache. The cache stores the limits for the current and the next two months.

The service requires an Internet connection, an account in Level2. The function is available since version 2.9.

If for some reason the data has not been received, the value nil will be returned.