mirror of
https://github.com/HASwitchPlate/openHASP.git
synced 2025-07-24 11:46:34 +00:00
update
This commit is contained in:
fvanroie
parent
d8481606ff
commit
9819c9b6d9
@ -1,100 +0,0 @@
|
||||
---
|
||||
title: "Quick-Start Guide"
|
||||
permalink: /projects/hasp-lvgl/quick-start-guide/
|
||||
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
|
||||
last_modified_at: 2020-04-27
|
||||
redirect_from:
|
||||
- /theme-setup/
|
||||
toc: true
|
||||
---
|
||||
|
||||
Minimal Mistakes has been developed as a [Gem-based theme](http://jekyllrb.com/docs/themes/) for easier use, and 100% compatible with GitHub Pages when used as a remote theme.
|
||||
|
||||
**If you enjoy this software, please consider [supporting me](https://www.paypal.me/netwize) for developing and maintaining it.**
|
||||
|
||||
[](https://www.paypal.me/mmistakes)
|
||||
|
||||
## Installing the theme
|
||||
|
||||
If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem.
|
||||
|
||||
[^structure]: See [**Structure** page]({{ "/docs/structure/" | relative_url }}) for a list of theme files and what they do.
|
||||
|
||||
**ProTip:** Be sure to remove `/docs` and `/test` if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't want them littering up your repo.
|
||||
{: .notice--info}
|
||||
|
||||
**Note:** The theme uses the [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin which will need to be installed in your `Gemfile` and added to the `plugins` array of `_config.yml`. Otherwise you'll throw `Unknown tag 'include_cached'` errors at build.
|
||||
{: .notice--warning}
|
||||
|
||||
|
||||
|
||||
### Firmware
|
||||
|
||||
Remote themes are similar to Gem-based themes, but do not require `Gemfile` changes or whitelisting making them ideal for sites hosted with GitHub Pages.
|
||||
|
||||
To install as a remote theme:
|
||||
|
||||
1. Create/replace the contents of your `Gemfile` with the following:
|
||||
|
||||
```ruby
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
```
|
||||
|
||||
2. Add `jekyll-include-cache` to the `plugins` array of your `_config.yml`.
|
||||
|
||||
3. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
|
||||
|
||||
```bash
|
||||
bundle
|
||||
```
|
||||
|
||||
4. Add `remote_theme: "mmistakes/minimal-mistakes@4.19.2"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
|
||||
|
||||
You may also optionally specify a branch, [tag](https://github.com/mmistakes/minimal-mistakes/tags), or commit to use by appending an @ and the Git ref (e.g., `mmistakes/minimal-mistakes@4.9.0` or `mmistakes/minimal-mistakes@bbf3cbc5fd64a3e1885f3f99eb90ba92af84063d`). This is useful when rolling back to older versions of the theme. If you don't specify a Git ref, the latest on `master` will be used.
|
||||
|
||||
**Looking for an example?** Use the [Minimal Mistakes remote theme starter](https://github.com/mmistakes/mm-github-pages-starter/generate) for the quickest method of getting a GitHub Pages hosted site up and running. Generate a new repository from the starter, replace sample content with your own, and configure as needed.
|
||||
{: .notice--info}
|
||||
|
||||
---
|
||||
|
||||
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).
|
||||
{: .notice--warning}
|
||||
|
||||
If you're hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than **USERNAME.github.io** and create a `gh-pages` branch off of `master`. For more details on how to set things up check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/).
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-gh-pages.gif' | relative_url }}" alt="creating a new branch on GitHub">
|
||||
</figure>
|
||||
|
||||
You can also install the theme by copying all of the theme files[^structure] into your project.
|
||||
|
||||
To do so fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-theme-fork-repo.png' | relative_url }}" alt="fork Minimal Mistakes">
|
||||
</figure>
|
||||
|
||||
**GitHub Pages Alternatives:** Looking to host your site for free and install/update the theme painlessly? [Netlify][netlify-jekyll], [GitLab Pages][gitlab-jekyll], and [Continuous Integration (CI) services][ci-jekyll] have you covered. In most cases all you need to do is connect your repository to them, create a simple configuration file, and install the theme following the [Ruby Gem Method](#ruby-gem-method) above.
|
||||
{: .notice--info}
|
||||
|
||||
[netlify-jekyll]: https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/
|
||||
[gitlab-jekyll]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/
|
||||
[ci-jekyll]: https://jekyllrb.com/docs/continuous-integration/
|
||||
|
||||
### Minimal Configuration
|
||||
|
||||
You need to setup network connectivity to your network and connect to an MQTT broker service.
|
||||
|
||||
## Home Automation
|
||||
|
||||
There are some examples available to help you integrate HASP into your Home Automation setup:
|
||||
- Home Assistant
|
||||
- OpenHAB
|
||||
- Node-RED
|
||||
- Tasmota Slave
|
||||
|
||||
**ProTip:** The source code and content files for this site can be found in the [`/docs` folder](https://github.com/mmistakes/minimal-mistakes/tree/master/docs) if you want to copy or learn from them.
|
||||
{: .notice--info}
|
||||
|
||||
@ -13,9 +13,9 @@ When a malformed line is encountered, the processing of the rest of the file sto
|
||||
If you are missing objects, check the logs to see which line was processed last.
|
||||
You probably have a typo in the following line which blocks parsing the rest of the file.
|
||||
|
||||
> **Note**</br>The complete file in its entirety is *not* a valid json file.
|
||||
> Each individual line however must be a valid json object.
|
||||
> The file extension is `.jsonl` and not `.json`.
|
||||
?> The complete file in its entirety is *not* a valid json file.
|
||||
?> Each individual line however must be a valid json object.
|
||||
?> The file extension is `.jsonl` and not `.json`.
|
||||
|
||||
### Objects
|
||||
Each line in `pages.jsonl` creates **one object** on a page and has to be in the json format.
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
- [Command Reference](./05-commands.md)
|
||||
- [Frequently Asked Questions](./06-faq.md)
|
||||
|
||||
- **settings**
|
||||
- **Settings**
|
||||
|
||||
- [Http](settings/30-http.md)
|
||||
- [Mqtt](settings/32-mqtt.md)
|
||||
|
||||
@ -63,6 +63,8 @@
|
||||
<!-- Docsify v4 -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-ini.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
|
||||
@ -70,10 +72,9 @@
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code@2/dist/docsify-copy-code.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-edit-on-github"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script>
|
||||
|
||||
<script src="https://unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination@2/dist/docsify-pagination.min.js"></script>
|
||||
|
||||
<script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
|
||||
</body>
|
||||
|
||||
|
||||
@ -1 +1,21 @@
|
||||
# Hasp-lvgl Documentation
|
||||
# Hasp-lvgl Documentation
|
||||
|
||||
## Purpose
|
||||
|
||||
Hasp-lvgl is a microcontroller firmware that can run on ESP and STM32F4 with an off-the-shelve touch display.
|
||||
You can use the hasp-lvgl firmware to create a custom touchscreen user interface.
|
||||
It can display information and you can create objects like touch buttons, switches and LEDs on the touchscreen to interact with your home automation system.
|
||||
|
||||
The communication is done over the network via MQTT.
|
||||
|
||||
This project is a re-implementation of the popular HASwitchPlate sketch created by aderusha. The original HASwitchPlate project uses a Wemos D1 mini and requires a Nextion/TJC HMI display. This rewrite removes the Nextion/TJC requirement by using the Littlev Graphics Library on the MCU to drive a cheap commodity display.
|
||||
|
||||
This version also adds ESP32 and STM32F4 support to take advantage of the additional hardware capabilities.
|
||||
|
||||
## Requirements
|
||||
|
||||
To run the firmware, you only need a compatible microcontroller and touch display.
|
||||
|
||||
**If you enjoy this software, please consider [supporting me](https://www.paypal.me/netwizeBE) for developing and maintaining it.**
|
||||
|
||||
[](https://www.paypal.me/netwizeBE)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user