240 lines
11 KiB
HTML
240 lines
11 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>OTS Signs Command Center Documentation</title>
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
|
||
<!-- favicon -->
|
||
<link href="../img/favicon.ico" rel="shortcut icon"/>
|
||
|
||
<!-- Bootstrap -->
|
||
<link href="../vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">
|
||
|
||
<!-- Stylesheets -->
|
||
<link href="../manual.css" rel="stylesheet" media="screen">
|
||
|
||
<!-- META -->
|
||
<meta name="keywords" content="digital signage, signage, narrow-casting, ots-signs, open source, agpl, documentation" />
|
||
<meta name="description" content="OTS Signs Command Center is an open source digital signage solution. It supports all main media types and can be interfaced to other sources of data using CSV, Databases or RSS." />
|
||
</head>
|
||
<body data-toc="widgets">
|
||
<!-- Copyright 2020 Xibo Signage Ltd. Part of the Xibo Open Source Digital Signage Solution. Released under the AGPLv3 or later. -->
|
||
<nav id="top-nav" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ss-navbar">
|
||
<span class="sr-only">Toggle navigation</span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a href="#" class="navbar-brand">OTS Signs Command Center Documentation</a>
|
||
</div>
|
||
|
||
<div class="collapse navbar-collapse" id="ss-navbar">
|
||
<ul class="nav navbar-nav">
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div class="ss_body container">
|
||
<div class="row">
|
||
<div class="col-md-3">
|
||
<ul id="side-nav" class="nav nav-pills nav-stacked">
|
||
<li><a href="index.html" data-toc-name="getting_started">Getting Started</a></li><li><a href="layouts_editor.html" data-toc-name="layouts">Layouts</a></li><li><a href="media_library.html" data-toc-name="media">Media</a></li><li><a href="media_modules.html" data-toc-name="widgets">Modules</a></li><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||
<html><body><ul>
|
||
<li>
|
||
<a href="media_modules.html">Modules</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_modules_connectors.html">Connectors</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_audio.html">Audio</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_calendar.html">Calendar</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_clock.html">Clock</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_countdown.html">Countdown</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_currencies.html">Currencies</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_dashboard.html">Dashboard</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_dataset.html">DataSet</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_embedded.html">Embedded</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_emergency_alerts.html">Emergency Alert</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_flash.html">Flash</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_googletraffic.html">Google Traffic</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_hls.html">HLS</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_htmlpackage.html">HTML Package</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_image.html">Image</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_localvideo.html">Local Video</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_mastodon.html">Mastodon</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_menuboards_category.html">Menu Board Category</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_menuboards_products.html">Menu Board Products</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_national_weather_service.html">National Weather Service</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_notifications.html">Notifications</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_pdf.html">PDF</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_powerpoint.html">PowerPoint</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_shellcommand.html">Shell Command</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_stocks.html">Stocks</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_ticker.html">Ticker</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_video.html">Video</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_video_in.html">Video In</a>
|
||
</li>
|
||
<li class="active">
|
||
<a href="media_module_weather.html">Weather</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_webpage.html">Webpage</a>
|
||
</li>
|
||
<li>
|
||
<a href="media_module_world_clock.html">World Clock</a>
|
||
</li>
|
||
</ul>
|
||
</body></html>
|
||
<li><a href="scheduling_events.html" data-toc-name="scheduling">Scheduling</a></li><li><a href="displays.html" data-toc-name="displays">Displays</a></li><li><a href="users_administration.html" data-toc-name="users">Users</a></li><li><a href="configure_cms_settings.html" data-toc-name="configure">Configuration and Organisation</a></li><li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="col-md-9" role="main">
|
||
<h1 id="weather">Weather <a href="#weather" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||
<p>Display daily weather forecast data anywhere on a Layout using <strong>Elements</strong> or select a <strong>Static Template</strong> to display results in Layouts/Playlists.</p>
|
||
<p>Weather data is provided by <a href="https://openweathermap.org/">OpenWeather</a> which is provided under <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA</a> and <a href="https://opendatacommons.org/licenses/odbl/">ODbL</a> which provides current worldwide daily weather forecasts which feed into configured Elements and Static Templates.</p>
|
||
<blockquote class="tip"><p>Please ensure that you are using a v3.2.1 or later CMS to account for API changes.</p>
|
||
<p>Visit <a href="https://openweathermap.org/api">Open Weather Map</a> to create an account and obtain an API key to enter into the Open Weather <a href="media_modules.html#content-connectors">Connector.</a></p>
|
||
<p><strong>NOTE:</strong> Since the release of Open Weather’s One Call 3.0, new users must enter credit card details to use the free x number of calls Key or opt for a paid subscription!</p>
|
||
<p>Open Weather Map allows 1000 requests for a forecast, per day before charging a small fee for each subsequent request.</p>
|
||
<p><strong>Paid plans</strong> unlock a 16 day forecast as well as other optimisations in the way the data is pulled through.</p>
|
||
</blockquote>
|
||
<blockquote class="noncloud"><p></p>
|
||
</blockquote>
|
||
<p>The Open Weather Map Terms of Service <a href="https://openweathermap.org/terms">https://openweathermap.org/terms</a> should be read and understood before using this Widget.</p>
|
||
<h2 id="weather_elements">Weather Elements <a href="#weather_elements" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||
<p>Elements are available for selection when adding the Weather Widget to a <a href="layouts_editor.html">Layout</a> to give Users more control over what components of the Weather Widget to use and where they can be placed.</p>
|
||
<p><img src="img/v4_media_module_weather_elements.png" alt="Weather Elements" /></p>
|
||
<p>Each Element has a set of configuration options in the Properties Panel. Enter the geographical location and units to return results from the <strong>Configure</strong> tab.</p>
|
||
<p>Control how items should be cycled by specifying a Data Slot to use for each of the added Elements. Data Elements can be further complimented by adding Global Elements to add shapes and text which can all be put into an Element Group for easier configuration and positioning.</p>
|
||
<blockquote class="tip"><p>All Layouts that use the Weather Widget need to include attribution, available by using the Attribution Element. Static Templates contain this tag by default.</p>
|
||
</blockquote>
|
||
<h2 id="weather_static_templates">Weather Static Templates <a href="#weather_static_templates" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||
<p>Static Templates define how returned results should be laid out and styled and are a simple way to show your data using pre-styled templates.</p>
|
||
<p><img src="img/v4_media_modules_weather_templates.png" alt="Weather Templates" /></p>
|
||
<p>Templates can be configured to make changes to the design appearance using a range of options in the Properties Panel. Enter geographical locations and units to return results from the <strong>Configure</strong> tab for each Template added to the Layout/Playlist.</p>
|
||
<h2 id="overview">Overview <a href="#overview" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||
<ul>
|
||
<li>Return results based on the Display Location.</li>
|
||
<li>Automatically set the unit of measurement to use to be based on the geographical location.</li>
|
||
<li>Automatically select weather forecasts based on Display Location.</li>
|
||
<li>Specify which Language to use.</li>
|
||
<li>Opt to show only daytime weather conditions.</li>
|
||
<li>Replace Background Images with images from the <a href="media_library.html">Library</a>
|
||
</li>
|
||
<li>Data for this media is cached by the Players for off-line playback.</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div> <!-- container-->
|
||
<footer class="ss_footer" role="contentinfo">
|
||
<div class="container">
|
||
<div class="pull-right">
|
||
<img class="img-responsive logo" src="../img/logo.png" alt="OTS Signs Command Center" />
|
||
</div>
|
||
|
||
<p class="ss_back_to_top">Back to Top</p>
|
||
|
||
<p class="ss_footer_links">Currently v4</p>
|
||
|
||
<p class="ss_languages"><a href="../en/index.html">en</a></p>
|
||
</div>
|
||
</footer>
|
||
|
||
<!-- JavaScript -->
|
||
<script src="../vendor/jquery/jquery.min.js"></script>
|
||
<script src="../vendor/bootstrap/js/bootstrap.min.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function() {
|
||
$(".ss-sidebar .list-group li").addClass("list-group-item");
|
||
$(".ss_body img").addClass("img-thumbnail");
|
||
$(".ss_body table").addClass("table");
|
||
|
||
// Set the selected page based on the TOC name
|
||
// Mark the appropriate top nav element as the selected page
|
||
$("#top-nav a").each(function() {
|
||
if ($(this).data().tocName == $("body").data().toc)
|
||
$(this).parent().addClass("active");
|
||
});
|
||
|
||
$(".ss_back_to_top").click(function() {
|
||
$('html, body').animate({scrollTop : 0},800);
|
||
});
|
||
|
||
if (inIframe()) {
|
||
console.log("In Frame");
|
||
$("#top-nav").css("display", "none");
|
||
$(".ss-sidebar").parent().css("display", "none");
|
||
}
|
||
});
|
||
|
||
function inIframe () {
|
||
try {
|
||
return window.self !== window.top;
|
||
} catch (e) {
|
||
return true;
|
||
}
|
||
}
|
||
</script>
|
||
</body>
|
||
</html>
|