projects/awtrix-light
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Stephan Mühl
2023-03-22 21:36:47 +01:00
parent 55b08c7fff
commit 26c1639032
13 changed files with 192 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/README.md
View File

@@ -1,17 +0,0 @@
# AWTRIX-LIGHT
If you like my work, please consider supporting the project.
Awtrix Light is a custom firmware for the [Ulanzi Smart Pixel clock](https://www.ulanzi.com/products/ulanzi-pixel-smart-clock-2882).
A standalone device that offers a simple and user-friendly interface, making it the perfect solution for non-techies who want to enjoy the benefits of the popular awtrix system.
It is ready to use straight out of the box, with time, date, temperature, and humidity pages pre-installed. You don't need to do anything other than turning it on to start using these features.
During the development of Awtrix Light, usability and simplicity are my top priorities. My aim is to make it easy for non-tech-savvy users to benefit from Awtrix Light without any headaches or hours of scripting.
Awtrix Light is ready to use straight out of the box, without the need for a single line of code or commands.
However, for those with more advanced skills, the customization options available with custom pages allow you to take Awtrix Light to its full potential.
With Awtrix Light, you can effortlessly bring your ideas to life and enjoy a hassle-free experience. Join the thousands of satisfied awtrix users who have already chosen Awtrix 2 and Awtrix Light and experience the difference today!
Join my discord channel with over 1400 Users
https://discord.gg/cyBCpdx

8
docs/_coverpage.md Normal file
View File

@@ -0,0 +1,8 @@
## AWTRIX LIGHT
> Awtrix Light is a custom firmware for the Ulanzi Smart Pixel clock.
[GitHub](https://github.com/Blueforcer/awtrix-light)
[Getting Started](#quick-start)

14
docs/_sidebar.md Normal file
View File

@@ -0,0 +1,14 @@
- Getting started
- [Quick start](quickstart.md)
- [Flasher](flasher.md)
- Settings
- [Webinterface](webinterface.md)
- [Onscreen](onscreen.md)
- MQTT
- [Commands](deploy.md)

2
docs/flasher.md Normal file
View File

@@ -0,0 +1,2 @@
[filename](/ ':include :type=iframe')

11
docs/flasher/firmware/README Normal file
View File

@@ -0,0 +1,11 @@
This directory is intended for PlatformIO Unit Testing and project tests.
Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.
More information about PlatformIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html

BIN
docs/flasher/firmware/boot_app0.bin Normal file
View File

Binary file not shown.

BIN
docs/flasher/firmware/bootloader.bin Normal file
View File

Binary file not shown.

BIN
docs/flasher/firmware/firmware.bin Normal file
View File

Binary file not shown.

30
docs/flasher/firmware/manifest.json Normal file
View File

@@ -0,0 +1,30 @@
{
"name": "AWTRIX Light",
"version": "0.29",
"home_assistant_domain": "AwtrixLight",
"funding_url": "https://blueforcer.de",
"new_install_prompt_erase": true,
"builds": [
{
"chipFamily": "ESP32",
"parts": [
{
"path": "bootloader.bin",
"offset": 4096
},
{
"path": "partitions.bin",
"offset": 32768
},
{
"path": "boot_app0.bin",
"offset": 57344
},
{
"path": "firmware.bin",
"offset": 65536
}
]
}
]
}

BIN
docs/flasher/firmware/partitions.bin Normal file
View File

Binary file not shown.

97
docs/flasher/index.html Normal file
View File

@@ -0,0 +1,97 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>AWTRIX LIGHT</title>
<meta
name="description"
content="Install Awtrix Light."
/>
<meta name="viewport" content="width=device-width" />
<meta name="color-scheme" content="dark light" />
<style>
body {
font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI",
Roboto, Ubuntu, sans-serif;
padding: 0;
margin: 0;
line-height: 1.4;
}
.content {
max-width: 600px;
margin: 0 auto;
padding: 12px;
}
h2 {
margin-top: 2em;
}
h3 {
margin-top: 1.5em;
}
a {
color: #03a9f4;
}
.invisible {
visibility: hidden;
}
.hidden {
display: none;
}
esp-web-install-button[install-unsupported] {
visibility: inherit;
}
.content pre {
max-width: 100%;
overflow-y: scroll;
}
.footer {
margin-top: 24px;
border-top: 1px solid #ccc;
padding-top: 24px;
text-align: center;
}
.footer .initiative {
font-style: italic;
margin-top: 16px;
}
table {
border-spacing: 0;
}
td {
padding: 8px;
border-bottom: 1px solid #ccc;
}
.radios li {
list-style: none;
line-height: 2em;
}
@media (prefers-color-scheme: dark) {
body {
background-color: #ffffff;
color: #4b4b4b;
}
a {
color: #58a6ff;
}
}
</style>
<script type="module" src="https://unpkg.com/esp-web-tools@8.0.1/dist/web/install-button.js?module"></script>
</head>
<body>
<div class="content">
<h1 align="center">AWTRIX Light installer</h1>
<p class="button-row" align="center">
<esp-web-install-button manifest="firmware/manifest.json"></esp-web-install-button>
</p>
<div class="footer">
<a href="https://github.com/Blueforcer/awtrix-light"
>Awtrix Light </a>
Installer powered by <a href="https://esphome.github.io/esp-web-tools/">ESP Web Tools</a>.
</div>
<script>
</script>
</body>
</html>

7
docs/index.html
View File

@@ -9,10 +9,15 @@
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<nav class="app-nav"></nav>
<div id="app">Loading ...</div>
<script>
window.$docsify = {
name: '',
loadSidebar: true,
coverpage: true,
loadNavbar: true,
mergeNavbar: true,
repo: 'https://github.com/Blueforcer/awtrix-light'
}
</script>

24
docs/quickstart.md Normal file
View File

@@ -0,0 +1,24 @@
# AWTRIX-LIGHT
If you like my work, please consider supporting the project.
Awtrix Light is a custom firmware for the [Ulanzi Smart Pixel clock](https://www.ulanzi.com/products/ulanzi-pixel-smart-clock-2882).
That offers a simple and user-friendly interface, making it the perfect solution for non-techies who want to enjoy the benefits of the popular awtrix system.
It is ready to use straight out of the box, with time, date, temperature, and humidity pages pre-installed. You don't need to do anything other than turning it on to start using these features.
During the development of Awtrix Light, usability and simplicity are my top priorities. My aim is to make it easy for non-tech-savvy users to benefit from Awtrix Light without any headaches or hours of scripting.
Awtrix Light is ready to use straight out of the box, without the need for a single line of code or commands.
However, for those with more advanced skills, the customization options available with custom pages allow you to take Awtrix Light to its full potential.
With Awtrix Light, you can effortlessly bring your ideas to life and enjoy a hassle-free experience.
Join the thousands of satisfied awtrix users who have already chosen Awtrix 2 and Awtrix Light and experience the difference today!
https://discord.gg/cyBCpdx
# Quick start
1. :computer: Flashing. Connect your device to your PC or Mac and [use the online flahser](flasher.md)
2. :signal_strength: After flashing, Awtrix will open an access point with the name "AWTRIX LIGHT". Connect with PW "12345678".
3. :mag: Open a browser and navigate to 192.168.4.1. Enter your WiFi information and reboot the clock.
4. :clock1: Your clock is accessible via http://awtrixlight.local/.
5. :gear: Set up your MQTT and other options in the web interface.
6. :heavy_check_mark: You're ready to go.