platypush-home/www/index.html

394 lines
17 KiB
HTML
Raw Normal View History

2021-02-04 23:40:20 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
2021-02-05 13:38:07 +01:00
<link rel="stylesheet" href="fonts/poppins.css">
<link rel="stylesheet" href="fonts/fira-sans.css">
2021-02-05 20:18:51 +01:00
<link rel="stylesheet" href="fonts/fira-code.css">
2021-02-05 13:38:07 +01:00
<link rel="stylesheet" href="css/application.css">
2021-02-04 23:40:20 +01:00
<title>Platypush</title>
2021-02-05 13:38:07 +01:00
<script type="text/javascript">
function toggleMobileMenu() {
const menu = document.getElementById('mobile-menu');
console.log(menu);
if (menu.classList.length)
menu.className = '';
else
menu.className = 'visible';
}
</script>
2021-02-04 23:40:20 +01:00
</head>
<body>
<header>
<div class="left">
<a href="https://platypush.tech" class="logo">
<img src="img/icon.png" alt="Logo">
<span class="name">Platypush</span>
</a>
</div>
2021-02-05 13:38:07 +01:00
<div class="right is-desktop">
2021-02-04 23:40:20 +01:00
<div class="item">
<a href="https://git.platypush.tech/platypush/platypush">Git</a>
2021-02-04 23:40:20 +01:00
</div>
<div class="item">
<a href="https://docs.platypush.tech">Docs</a>
2021-02-04 23:40:20 +01:00
</div>
<div class="item">
<a href="https://blog.platypush.tech">Blog</a>
</div>
<div class="item">
2022-07-07 01:32:04 +02:00
<a href="https://git.platypush.tech/platypush/platypush/wiki">Wiki</a>
2021-02-04 23:40:20 +01:00
</div>
2021-03-26 01:20:31 +01:00
<div class="item">
<a href="https://f-droid.org/en/packages/tech.platypush.platypush/" target="_blank">App</a>
</div>
<div class="item">
2022-05-09 22:10:47 +02:00
<a href="https://social.platypush.tech" target="_blank">Social</a>
</div>
2021-02-04 23:40:20 +01:00
</div>
2021-02-05 13:38:07 +01:00
<div class="right is-mobile">
<button type="button" class="menu-icon" title="Menu" onclick="toggleMobileMenu()">
<img src="img/menu-icon.png">
</button>
</div>
2021-02-04 23:40:20 +01:00
</header>
<main>
<section>
<div class="left">
<div class="title">
Connect things and services together with Platypush
</div>
<div class="content">
Platypush is an open-source modular platform for automation aimed to run on any device that
can run a Python interpreter.
</div>
</div>
<div class="right">
<img src="img/preview.png" alt="App preview">
</div>
</section>
<section>
<div class="left">
<img src="img/integrations.png" alt="Integrations">
</div>
<div class="right">
<div class="title">
Control devices and services through hundreds of available integrations.
</div>
<div class="content">
Platypush comes with many integrations, each wrapped by a consistent API, making it very easy to
create automation routines when a certain event happens, programmatically action them in your
scripts, or control them all from a single consistent web interface.
2021-02-25 00:00:03 +01:00
<a href="https://docs.platypush.tech" target="_blank">Discover the available integrations</a>.
2023-08-20 23:14:08 +02:00
The <a href="https://git.platypush.tech/platypush/platypush/src/branch/master/README.md"
target="_blank">README</a> is also a good place to get started.
2021-02-04 23:40:20 +01:00
</div>
</div>
</section>
2021-02-05 13:38:07 +01:00
2021-02-05 20:18:51 +01:00
<section>
<div class="left">
<div class="title">
Easy to install, easy to extend.
</div>
<p>
Platypush comes with an intentionally thin core that dispatches messages and events over Redis, and
its power comes from the high number of integrations it provides. It's up to the user to decide the
pick the use case and use the appropriate extensions.
</p>
<p>
Extensions may come with optional sets of additional dependencies, and they can be easily installed
through <tt>pip</tt> - see the <a
2023-08-20 23:14:08 +02:00
href="https://git.platypush.tech/platypush/platypush/src/branch/master/setup.py#L85"
2021-02-05 20:18:51 +01:00
target="_blank"><tt>setup.py</tt></a> for a full list of supported extras. The <a
href="https://docs.platypush.tech" target="_blank">documentation</a> also provided the required
dependencies for each integration.
</p>
</div>
<div class="right">
2023-08-20 23:14:08 +02:00
<div class="code">pip install <span class="string">'platypush[mqtt]'</span></div>
2021-02-05 23:12:58 +01:00
</div>
</section>
<section>
<div class="left">
2023-08-20 23:14:08 +02:00
<div class="code"><span class="comment"># Enable the Zigbee2MQTT integration</span>
<span class="keyword">zigbee.mqtt</span>:
<span class="keyword">- host</span>: 192.168.1.2
2021-02-05 23:12:58 +01:00
<span class="comment"># Enable the Philips Hue plugin</span>
<span class="keyword">light.hue</span>:
2023-08-20 23:14:08 +02:00
<span class="keyword">- bridge</span>: 192.168.1.3
2021-02-05 23:12:58 +01:00
</div>
</div>
<div class="right">
<div class="title">
Easily configure your integrations.
</div>
Configuring an integration is as simple as defining its attributes in
<tt>~/.config/platypush/config.yaml</tt>. The attributes of each integration are the same as their
documented constructors, and an
2023-08-20 23:14:08 +02:00
<a href="https://git.platypush.tech/platypush/platypush/src/branch/master/examples/conf/config.yaml">example configuration</a>
2021-02-05 23:12:58 +01:00
is also provided.
</div>
</section>
<section>
<div class="left">
<div class="title">
Create hooks that connect events to actions.
</div>
<p>
It's very easy to create pieces of logic that run some custom actions when an event is triggered.
Just drop a Python script into <tt>~/.config/platypush/scripts</tt>, or create a YAML snippet into
your <tt>config.yaml</tt>.
</p>
<p>The interface of the available events is also provided on the documentation, as well as the
methods exposed by each plugin and its parameters.</p>
</div>
<div class="right">
<div class="code"><span class="keyword">from</span> platypush.event.hook <span class="keyword">import</span> hook
<span class="keyword">from</span> platypush.utils <span class="keyword">import</span> run
2023-08-20 23:14:08 +02:00
<span class="keyword">from </span>platypush.message.event.zigbee.mqtt <span class="keyword">import</span> ZigbeeMqttDevicePropertySetEvent
<span class="keyword">@hook</span>(ZigbeeMqttDevicePropertySetEvent, device=<span class="string">'My motion sensor'</span>)
<span class="keyword">def</span> on_sensor_value_change(event, **ctx):
has_motion = event.args.get(<span class="string">'properties'</span>, {}).get(<span class="string">'motion'</span>)
<span class="comment"># Turn on the lights when motion is detected</span>
<span class="keyword">if</span> has_motion <span class="keyword">is</span> <span class="string">True</span>:
run(<span class="string">'light.hue.on'</span>)
<span class="comment"># Turn off the lights when motion is not detected</span>
<span class="keyword">elif</span> has_motion <span class="keyword">is</span> <span class="string">False</span>:
run(<span class="string">'light.hue.off'</span>)
2021-02-05 23:12:58 +01:00
</div>
</div>
</section>
<section>
<div class="left">
<img src="img/zwave-screenshot.png" alt="Web panel screenshot">
</div>
<div class="right">
<div class="title">
Easily control all of your devices and integrations from a single interface.
</div>
<div class="content">
<tt>backend.http</tt> also provides a web panel that will allow you to easily control all of your
integrations from a single place, on top of exposing a simple JSON-RPC API that allows you to
2021-03-26 01:20:31 +01:00
control your integrations from any place and any script. The web interface is responsive, works on
any device, and you can easily use it to control multiple instances through the
<a href="https://f-droid.org/en/packages/tech.platypush.platypush/" target="_blank">mobile app</a>.
2021-02-05 23:12:58 +01:00
</div>
</div>
</section>
<section>
<div class="left">
<div class="title">
Get inspired with periodic blog articles.
</div>
<div class="content">
The <a href="https://blog.platypush.tech">blog</a> is a useful resource with many articles on how to
set up IoT device, how to create your own and how to use Platypush to glue everything together -
from voice assistants, to calendars, to robots, to media centers, and so on.
</div>
</div>
<div class="right">
<img src="img/blog.png" alt="Blog screenshot">
</div>
</section>
<section>
<div class="left">
<img src="img/extension.png" alt="Web extension">
</div>
<div class="right">
<div class="title">
Use the web extension to debug your remote instances and run actions directly from your browser.
</div>
<div class="content">
<tt>backend.http</tt> also provides a web panel that will allow you to easily control all of your
integrations from a single place, on top of exposing a powerful API request editor that allows you
to control your integrations from any place and any script. The extension is available for
<a href="https://chrome.google.com/webstore/detail/platypush/aphldjclndofhflbbdnmpejbjgomkbie" target="_blank">Chrome</a>
and <a href="https://addons.mozilla.org/en-US/firefox/addon/platypush/" target="_blank">Firefox</a>,
and the <a href="https://git.platypush.tech/platypush/platypush-webext" target="_blank">source
code</a> is publicly available.
</div>
</div>
</section>
<section>
<div class="left">
<div class="title">
Create your own dashboards.
</div>
<div class="content">
Create your own all-screen dashboards with custom widgets to always keep an eye on e.g. calendar
events, media status, weather, sensors, news or your own pictures carousel.
</div>
</div>
<div class="right">
<img src="img/dashboard.png" alt="Dashboard screenshot">
</div>
</section>
<section>
<div class="left">
<img src="img/grafana.png" alt="Grafana screenshot">
</div>
<div class="right">
<div class="title">
Use Platypush to glue devices, databases and user interfaces.
</div>
<div class="content">
Platypush can be the bridge that connects your sensors, mobile and IoT devices to databases and
message queues and to Grafana to create
<a href="https://blog.platypush.tech/article/How-to-build-your-personal-infrastructure-for-data-collection-and-visualization">advanced visualizations of your data</a>.
Be the owner of your data again, and visualize it wherever you like, however you like.
</div>
</div>
</section>
<section>
<div class="left">
<div class="title">
Control all of your devices and services over chat bots and voice.
</div>
<div class="content">
Use the available
<a href="https://blog.platypush.tech/article/Build-custom-voice-assistants">voice assistant</a>
or
<a href="https://blog.platypush.tech/article/Build-a-bot-to-communicate-with-your-smart-home-over-Telegram">chat bot</a>
integrations to interact with your smart devices and services over voice (all you need is a USB
microphone) or chat bots (all you need is a messaging account).
</div>
</div>
<div class="right">
<img src="img/telegram-bot.png" alt="Telegram bot screenshot" style="width: auto; height: 70%">
</div>
</section>
<section>
<div class="left">
<img src="img/media-screenshot.png" alt="Media screenshot">
</div>
<div class="right">
<div class="title">
All of your media devices and sources in one place.
</div>
<div class="content">
With its numerous media integrations and a comprehensive web control panel, Platypush can turn a
device as powerful as a Raspberry Pi 4 into the ultimate media center and streaming center.
</div>
</div>
</section>
<section>
<div class="left">
<div class="title">
IoT-powered, events-oriented and self-hosted machine learning.
</div>
<div class="content">
Set up pipelines to automatically gather data from your events and dynamically train machine learning
models to e.g.
<a href="https://blog.platypush.tech/article/Detect-people-with-a-RaspberryPi-a-thermal-camera-Platypush-and-a-pinch-of-machine-learning">detect the presence of people</a> or
<a href="https://blog.platypush.tech/article/Create-your-smart-baby-monitor-with-Platypush-and-Tensorflow">recognize specific sounds</a>.
</div>
</div>
<div class="right">
<img src="img/ml.png" alt="ML model screenshot" style="width: 80%">
</div>
</section>
<section>
<div class="left">
<div class="content">
<p>
Platypush is and will always remain free, open-source and on-prem.
If you have questions, suggestions, issues or want to contribute to the project:
</p>
<ul>
2022-09-26 11:58:17 +02:00
<li>Open a <a href="https://git.platypush.tech/platypush/platypush/issues" target="_blank">
Gitea issue</a>.</li>
<li>Submit a <a href="https://git.platypush.tech/platypush/platypush/pulls" target="_blank">
pull request</a>.</li>
2022-05-27 00:19:44 +02:00
<li><a href="mailto:admin@platypush.tech" target="_blank">Email us</a>.</li>
2022-09-26 11:58:17 +02:00
<li>Give a shout on our <a rel="me" href="https://social.platypush.tech/@blacklight"
2022-05-27 00:19:44 +02:00
target="_blank">Mastodon instance</a>.</li>
2022-09-26 11:58:17 +02:00
<li>Join the chat on <a href="https://matrix.to/#/#platypush:matrix.platypush.tech">Matrix</a>
or IRC (<tt>irc.platypush.tech:6697</tt>, SSL only).</li>
2023-07-16 17:30:13 +02:00
<li>Reach out on <a href="https://lemmy.platypush.tech/c/platypush" target="_blank">
Lemmy</a>.</li>
2021-02-05 23:12:58 +01:00
<li>Donations to cover the costs for hosting the infrastructure <a
href="https://paypal.me/fabiomanganiello" target="_blank">are also welcome</a>!
</li>
</ul>
</div>
</div>
<div class="right">
<div class="title">
Contact us or contribute.
2021-02-05 20:18:51 +01:00
</div>
</div>
</section>
2021-02-05 13:38:07 +01:00
<div id="mobile-menu">
<div class="item">
<a href="https://git.platypush.tech/platypush" target="_blank">Git</a>
</div>
<div class="item">
<a href="https://docs.platypush.tech" target="_blank">Docs</a>
</div>
<div class="item">
<a href="https://blog.platypush.tech">Blog</a>
</div>
<div class="item">
2022-07-07 01:32:04 +02:00
<a href="https://git.platypush.tech/platypush/platypush/wiki" target="_blank">Wiki</a>
2021-02-05 13:38:07 +01:00
</div>
2021-03-26 01:20:31 +01:00
<div class="item">
<a href="https://f-droid.org/en/packages/tech.platypush.platypush/" target="_blank">App</a>
</div>
2021-02-05 13:38:07 +01:00
</div>
2021-02-04 23:40:20 +01:00
</main>
</body>
</html>
2021-02-05 13:38:07 +01:00