blink1-tool/server/html/index.html

77 lines
2.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,maximum-scale=2">
<link rel="stylesheet" type="text/css" media="screen" href="/css/style-slate.css">
<title>blink1-tiny-server</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/todbot/blink1-tool">View on GitHub</a>
<h1 id="project_title">blink1-tiny-server</h1>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1 id="blink1-tool">blink(1) URL API examples</h1>
<p>Example of using the HTTP REST API to talk to <a href="https://blink1.thingm.com/">blink(1) USB RGB LED notification lights</a>.</p>
<p>To see the source visit: <a href="https://github.com/todbot/blink1-tool/tree/master/server/html">https://github.com/todbot/blink1-tool/tree/master/server/html</a></p>
<h3> List of examples: </h3>
<p>Some browser-based examples controlling a blink(1) via <code>blink1-tiny-server</code> HTTP API</p>
<ul>
<li><a href="./blink1-demo-simplest/">blink1-demo-simplest</a> bare-bones example of lighting a blink(1)</li>
<li><a href="./blink1-demo-colorpicker/">blink1-demo-colorpicker</a> color picker with fast updates to blink(1)</li>
<li><a href="./blink1-demo-party/">blink1-demo-party</a> slightly more complex example</li>
</ul>
<h3> API documentation: </h3>
<p>
The API understood by <code>blink1-tiny-server</code> is a subset of the HTTP REST API provided by the Blink1Control2 app.
</p>
<ul>
<li><a href="https://github.com/todbot/blink1/blob/master/docs/app-url-api-examples.md">HTTP API examples </a>(for Blink1Control)</li>
<li><a href="https://github.com/todbot/blink1/blob/master/docs/app-url-api.md">HTTP API documentation for Blink1Control</a> (for Blink1Control)</li>
</ul>
<h3> Pre-requisites for these examples, you will need: </h3>
<ul>
<li>blink(1) USB LED</li>
<li>A browser that supports <a href="https://caniuse.com/fetch">Fetch</a></li>
<li>Run <code class="language-plaintext highlighter-rouge">blink1-tiny-server -p <span id="port1">8000</span> </code></li>
<li>Visit: <a id="url1" href="http://localhost:8000">http://localhost:<span id="port2">8000</span></a></li>
</ul>
</section>
</div>
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">blink1-tool maintained by <a href="https://github.com/todbot">todbot</a></p>
</footer>
</div>
</body>
<script>
// rewrite the localhost URLs so they work if user changes port
let port = location.port;
document.getElementById("port1").innerHTML = "" + port;
document.getElementById("port2").innerHTML = "" + port;
document.getElementById("url1").href = "http://localhost:"+port+"/";
</script>
</html>