229 lines
9.5 KiB
HTML
229 lines
9.5 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 class="active">
|
||
<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>
|
||
<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="shell_command">Shell Command <a href="#shell_command" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||
<p>Use Shell Command to instruct the Display to execute a command outside of the OTS Signs Command Center environment, using the operating system shell.</p>
|
||
<blockquote class="tip"><p>Add the Shell Command Widget to Layouts to execute external commands, such as ‘volume up’ for a Layout with an Audio Widget that is set to play, and ‘volume down’ when the Layout finishes.</p>
|
||
</blockquote>
|
||
<blockquote class="cloud"></blockquote>
|
||
<h2 id="overview">Overview <a href="#overview" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||
<ul>
|
||
<li>The command is executed when a Layout/Playlist containing the Shell Command Widget plays at its scheduled time.</li>
|
||
<li>Select a preconfigured stored command.</li>
|
||
<li>Create a command string using the command builder to pass directly to the shell, further information can be found <a href="displays_command_functionality.html">here.</a>
|
||
</li>
|
||
<li>Enter a command string using free text.</li>
|
||
<li>Global commands allow for compatible commands to work with all Player types.</li>
|
||
<li>Android and Linux Players require root access to use Shell Commands.</li>
|
||
<li>Enable launching created commands via Windows Command Line (cmd.exe)</li>
|
||
<li>Run a command for a fixed period by setting a duration, for example where your command shows something on the screen for a time and cannot close itself.</li>
|
||
</ul>
|
||
<blockquote class="tip"><p>On ticking the <strong>Set a duration</strong> box and entering a time in seconds on the <strong>Advanced</strong> tab, options will be made available on the <strong>Configuration</strong> tab to instruct OTS Signs Command Center to terminate the command it started running.</p>
|
||
<p>In most cases, commands that are run from a Layout / Playlist tend to be background commands which trigger something to happen like screen on/off or restart the device etc. In such cases, the Set a duration box can be left unticked.</p>
|
||
<p>For commands that are executed on a specific date/time, such as ‘reboots’, ‘turn on/off’ on opening/closing times for example, then please see the <a href="scheduling_events">Add Event</a> in the Scheduling section and <a href="displays.html#content-send-command">Send Command</a> in the Displays section.</p>
|
||
</blockquote>
|
||
<h4>Next…</h4>
|
||
<p><a href="displays_command_functionality.html">Command Functionality</a></p>
|
||
|
||
</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>
|