deploy: 36e41c9

r-cute · Jul 9, 2024 · 582428d · 582428d
commit 582428d
Show file tree

Hide file tree

Showing 200 changed files with 14,529 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/faq.html b/faq.html
@@ -0,0 +1,78 @@
+<!DOCTYPE html><html><head><title>xDial</title><meta charset="UTF-8"><meta name='viewport' content='width=device-width, initial-scale=1'/><style>
+	*{font-size:1em;margin:.25em}h1{font-size:1.25em;text-align:center;}
+	h2{margin:.75em auto;}h2::after{content:"➖";float:right;}.hidden>h2::after{content:"➕"}
+	.hidden>:not(h2){display:none}section{border-top:1px solid #ccc}
+	p{text-indent:2em;margin:0.75em}i{font-size:0.95em;background:#fee}u{font-style:italic;font-size:0.95em;background:#efe;text-decoration:none;}
+</style><script src='util.js'></script><script>
+t_hide=(e,b)=>e.classList.toggle("hidden",b);
+addEventListener('load',()=>{
+	qa('h2').forEach(h=>{var p=h.parentNode;t_hide(p,1);h.onclick=e=>{qa('section').forEach(d=>q('h2',d)!=h&&t_hide(d,1));t_hide(p);}});
+	var loc=location.hash;if(loc){var el=q(location.hash);if(el){q('h2',loc).onclick();}}
+});
+</script></head><body>
+	<h1>常见问题</h1>
+	<section id='reset_wifi'>
+		<h2>如何重置 WiFi？</h2>
+		<p>设备启动时若无法连接 WiFi，会自动进入 WiFi 配网状态。</p>
+		<p>
+			您也可以手动让设备进入 WiFi 配网状态：
+			<ol>
+				<li>在设备上电前按住<em>左</em>键，并在启动时保持按下状态约1秒直到“嘀”的一声。</li>
+				<li>根据提示连接设备提供的 WiFi 热点进行设置。</li>
+			</ol>
+		</p>
+	</section>
+	<section id='go_to_settings'>
+		<h2>无法访问设置页面</h2>
+		<p>
+			<ol>
+				<li>请检查设备已联网且与您的手机处于同一局域网内。</li>
+				<li>进入设备的<u>设置</u>界面，点击右键可开启/关闭设置页面。确保其为开启状态。</li>
+				<li>扫描设备屏幕上的二维码或访问其下方的网址便可进入设置页面。</li>
+			</ol>
+		</p>
+	</section>
+	<section id='no_weather_data'>
+		<h2>没有天气数据</h2>
+		<p>天气数据是通过<em>免费</em>订阅<a href='https://www.qweather.com' target='_blank'>和风天气</a>获取的，步骤如下：
+			<ol>
+				<li><a href='https://dev.qweather.com/' target='_blank'>注册</a>和风天气的开发账号。</li>
+				<li>登录<a href='https://console.qweather.com/#/apps' target='_blank'>项目管理</a>页面 > 点击<i>创建项目</i> > 选择<i>免费订阅</i>和<i>Web API</i> > <i>创建</i> > <i>查看</i>并复制 KEY。</li>
+				<li>转到<i>设置</i>页面，在<i>天气</i>里填入 KEY，查找并选择您所在城市，然后点击<i>保存</i>。</li>
+				<li>进入设备的<u>天气</u>界面查看，若仍然没有数据，可点击右键刷新，根据对应的<a href='https://dev.qweather.com/docs/resource/status-code/' target='_blank'>错误状态码</a>可选表盘</li>
+			</ol>
+		</p>
+		<p><a href='get_qweather_key.vid.html' target='_blank'>视频演示</a></p>
+		<p style="font-size:0.85em;text-indent:0;">
+			注意：免费订阅的 KEY 每日使用次数有限，请勿与他人分享。
+		</p>
+	</section>	
+	<section id='delete_clock_face'>
+		<h2>下载可选表盘后设备不断重启</h2>
+		<p>表盘下载过程出错或表盘文件本身格式错误都可能导致设备在加载表盘时出错而重启。</p>
+		<p>您可以尝试让设备启动时跳过表盘加载，然后进入设置页面删除可选表盘：
+			<ol>
+				<li>在设备上电前按住<em>右</em>键，并在启动时保持按下状态约1秒直到“嘀”的一声。</li>
+				<li>若设备能顺利启动，您可以在<i>设置</i>页面 > <i>表盘</i> > <i>(可选表盘)</i> > 点击<i>删除</i>按钮来删除可选表盘。</li>
+				<li>若问题仍未解决，您可以尝试<a href='#' onclick='q("#factory_reset>h2").click()'>恢复出厂设置</a>。</li>
+			</ol>
+		</p>
+	</section>
+	<section id='factory_reset'>
+		<h2>如何恢复出厂设置？</h2>
+		<p>您可以在设备启动阶段恢复出厂设置，这可能有助于解决一些未知问题：
+			<ol>
+				<li>在设备上电前同时按住<em>左</em>键和<em>右</em>键，并在启动时保持按下状态约1秒直到“嘀嘀”两声。</li>
+				<li>此时设备将删除设置页面里的所有个性化设置（包括和风天气的 KEY 和可选表盘），但保留 WiFi 设置。</li>
+			</ol>
+		</p>
+	</section>
+	<section id='custom_clock_face'>
+		<h2>如何制作表盘？</h2>
+		<p>表盘制作教程还在准备中...</p>
+	</section>
+	<section id='custom_firmware'>
+		<h2>能否刷入第三方固件？</h2>
+		<p>不能，设备串口已关闭。</p>
+	</section>
+</body></html>
diff --git a/gallery/index.html b/gallery/index.html
@@ -0,0 +1 @@
+<html><script>location.pathname='xdial_cf_gallery';</script><body></body></html>
diff --git a/index.html b/index.html
@@ -0,0 +1,7 @@
+<!DOCTYPE html><html><head><title>xDial</title><meta charset="UTF-8"><meta name='viewport' content='width=device-width, initial-scale=1'/><style>
+
+</style><script src='util.js'></script><script>
+
+</script><body>
+
+</body></head>
diff --git a/manual/en/.buildinfo b/manual/en/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 71324296fa278dfa31ff5a2dcc4558f0
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/manual/en/.nojekyll b/manual/en/.nojekyll
diff --git a/manual/en/_images/cf_list.dev.png b/manual/en/_images/cf_list.dev.png
diff --git a/manual/en/_images/cf_opt.web.png b/manual/en/_images/cf_opt.web.png
diff --git a/manual/en/_images/clock_faces.web.png b/manual/en/_images/clock_faces.web.png
diff --git a/manual/en/_images/gallery.web.png b/manual/en/_images/gallery.web.png
diff --git a/manual/en/_images/input.png b/manual/en/_images/input.png
diff --git a/manual/en/_images/left_btn_back.dev.png b/manual/en/_images/left_btn_back.dev.png
diff --git a/manual/en/_images/left_btn_func.dev.png b/manual/en/_images/left_btn_func.dev.png
diff --git a/manual/en/_images/menu_cf.dev.png b/manual/en/_images/menu_cf.dev.png
diff --git a/manual/en/_images/menu_perfmon.dev.png b/manual/en/_images/menu_perfmon.dev.png
diff --git a/manual/en/_images/menu_settings.dev.png b/manual/en/_images/menu_settings.dev.png
diff --git a/manual/en/_images/ota.web.png b/manual/en/_images/ota.web.png
diff --git a/manual/en/_images/perfmon.dev.png b/manual/en/_images/perfmon.dev.png
diff --git a/manual/en/_images/settings.dev.png b/manual/en/_images/settings.dev.png
diff --git a/manual/en/_images/settings.web.png b/manual/en/_images/settings.web.png
diff --git a/manual/en/_images/wifi_prov.dev.png b/manual/en/_images/wifi_prov.dev.png
diff --git a/manual/en/_sources/clock_faces.rst.txt b/manual/en/_sources/clock_faces.rst.txt
@@ -0,0 +1,49 @@
+Clock Faces
+=================
+
+
+.. figure:: _static/menu_cf.dev.png
+   :class: dev
+
+   Go to "Clock faces" selection interface
+
+.. figure:: _static/cf_list.dev.png
+   :class: dev
+
+   Choose from built-in clock faces and optional ones.
+
+
+Built-in clock faces
+--------------------------
+
+| In settings web page, select relevant clock face from drop down menu. 
+| Color or style of built-in clock faces are customizable.
+
+.. image:: _static/clock_faces.web.png
+   :class: web
+   :align: center
+
+\
+
+
+Optional clock faces
+-------------------------
+
+Optional clock faces can be downloaded.
+
+Select "optional N" from drop down menu. then click the "gallery" link
+
+.. image:: _static/cf_opt.web.png
+   :class: web
+   :align: center
+
+\
+
+Download clock face of choice by clicking the ⬇️ button.
+
+.. image:: _static/gallery.web.png
+   :class: web
+   :align: center
+
+\
+
diff --git a/manual/en/_sources/faq.rst.txt b/manual/en/_sources/faq.rst.txt
@@ -0,0 +1,61 @@
+FAQ
+============
+
+如何重置 WiFi？
+----------------
+
+设备启动时若无法连接 WiFi，会自动进入 WiFi 配网状态。
+
+在设备已经联网时，如果需要重置或更改 WiFi 配置，可以手动让设备进入配网状态：
+
+	#. 在设备上电前按住 **左键** ，并在启动时保持按下状态约 1 秒直到 “嘀” 的一声。
+	#. 根据提示连接设备提供的 WiFi 热点进行设置。
+
+无法访问设置页面
+---------------------------
+
+	#. 确保设备与您的手机处于同一局域网内。
+	#. `开启设备的设置功能 <settings/>`_
+
+没有天气数据
+-------------------
+
+	#. 完成 `天气设置 <weather/>`_
+	#. 若天气界面仍然没有数据，可点击右键刷新，根据和风天气网站对应的 `错误状态码 <https://dev.qweather.com/docs/resource/status-code/>`_ 排查原因。
+
+下载表盘后设备不断重启
+------------------------------
+
+表盘下载过程出错或表盘文件本身格式错误都可能导致设备在加载表盘时出错而重启。
+
+您可以尝试让设备启动时跳过表盘加载，然后进入设置页面删除可选表盘：
+
+	#. 在设备上电前按住 **右键** ，并在启动时保持按下状态约 1 秒直到 “嘀” 的一声。
+	#. 若设备能顺利启动，您可以在 *设置* 页面 → *表盘* → *(可选表盘n)* → 点击 *删除* 按钮来删除对应表盘。
+	#. 若问题仍未解决，您可以尝试 :ref:`恢复出厂设置 <如何恢复出厂设置？>` 。
+
+
+
+如何恢复出厂设置？
+-------------------------
+
+* 在设置页面点击 **重置** 按钮，设备将恢复出厂设置并重启。
+
+\
+
+* 也可以在设备启动阶段恢复出厂设置：
+
+	#. 在设备上电前同时按住 **左键和右键** ，并在启动时保持按下状态约 1 秒直到 “嘀嘀” 两声。	
+	#. 此时设备将删除设置页面里的所有个性化设置（包括和风天气的 KEY 和可选表盘），但保留 WiFi 设置。
+
+
+
+如何制作表盘？
+------------------
+
+表盘制作教程还在准备中...
+
+能否刷入第三方固件？
+--------------------------
+
+不能，设备串口已关闭。
diff --git a/manual/en/_sources/index.rst.txt b/manual/en/_sources/index.rst.txt
@@ -0,0 +1,40 @@
+User Manual
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   wifi_provision
+   input
+   settings
+   ota
+   clock_faces
+   weather
+   perfmon
+   faq
+
+
+Product parameters
+--------------------
+
+.. csv-table::
+
+   "Shell", "Resin 3D printed"
+   "Size", "52*47*54 mm"
+   "Screen", "Ø 32 mm, 240*240 pixels"
+   "Power", "DC 5V, USB Type-C (no battery)"
+   "Processor", "ESP32-C3"
+   "WiFi", "2.4 GHz, 802.11 b/g/n"
+   "Flash", "32 Mbit"
+   "Language", "En/中文"
+
+⚠️ The shell is 3D printed with resin, it may soften and deform in high-temperature environment.
+
+
+..
+      Indices and tables
+      ==================
+
+      * :ref:`genindex`
+      * :ref:`modindex`
+      * :ref:`search`
diff --git a/manual/en/_sources/input.rst.txt b/manual/en/_sources/input.rst.txt
@@ -0,0 +1,20 @@
+Dial and Buttons
+==================
+
+.. image:: _static/input.png
+   :align: center
+   :scale: 75%
+\   
+
+| Usually the left button is denoted with ← icon, you can press it to go back to menu interface.
+| In other caces, when special functions are assign to left button, to go back, you'll have to long press left button.
+
+.. figure:: _static/left_btn_func.dev.png
+   :class: dev
+
+   In pomodoro, left button has reset icon ⏪
+
+.. figure:: _static/left_btn_back.dev.png
+   :class: dev
+
+   It'll turn ← after long press
diff --git a/manual/en/_sources/ota.rst.txt b/manual/en/_sources/ota.rst.txt
@@ -0,0 +1,10 @@
+OTA Update
+=============
+
+You can check for available firmware updates in the "Update" section.
+
+.. image:: _static/ota.web.png
+   :class: web
+   :align: center
+
+\
diff --git a/manual/en/_sources/perfmon.rst.txt b/manual/en/_sources/perfmon.rst.txt
@@ -0,0 +1,27 @@
+Perfmon
+===============
+
+The device can be used as a simple performance monitor to show your PC's CPU/GPU/RAM usage and so.
+
+.. figure:: _static/menu_perfmon.dev.png
+   :class: dev
+
+   Select "Perfmon" in menu
+
+.. figure:: _static/perfmon.dev.png
+   :class: dev
+
+   Press right buttton ⊙ to turn on/off perfmon server.
+
+On the PC side, you need to download and run a client software that can read and send those data to devic to be shown.
+
+.. toctree::
+   :maxdepth: 1
+
+   perfmon_win
+   perfmon_mac
+   perfmon_linux
+
+.. warning::
+   Currently only Windows OS is supported, more coming later.
+
diff --git a/manual/en/_sources/perfmon_win.rst.txt b/manual/en/_sources/perfmon_win.rst.txt
@@ -0,0 +1,65 @@
+Perfmon for Windows
+++++++++++++++++++++++
+
+下载主机端程序 |LibreHardwareMonitor_for_xDial.zip| ，**全部解压** 后运行 LibreHardwareMonitor_for_xDial.exe（可能需要管理员权限）
+
+.. image:: _static/librehardwaremonitor_exe.png
+   :class: border
+   :align: center
+   :scale: 90%
+
+\
+
+
+.. note::
+   该软件需要 .NET Framework 4.7.2 或以上版本支持，Windows 10/11 已经预装。Windows 10 之前的系统可能需要自行 |下载安装 .Net 4.7.2 运行环境|
+
+目前笔者对该软件与 xDial 相关的菜单做了汉化，您可以在软件中看到主机的许多性能指标。您还可以在 *选项* 菜单里选择 *开机启动*、 *最小化到托盘*、*更新间隔* 等。 
+
+找到 CPU 负载（Load → CPU Total）对应的指标，单击右键 → 选择 *复制传感器 ID*
+
+.. image:: _static/librehardwaremonitor_copy_sensor_id.png
+   :class: border
+   :align: center
+   :scale: 80%
+
+\
+
+点击菜单 *选项* → *xDial 性能监视* → *设置*
+
+.. image:: _static/librehardwaremonitor_menu_xdial_config.png
+   :align: center
+   :scale: 80%
+   :class: border
+
+\
+
+在对话框中填入 xDial 设备对应的 IP 地址(可在设备的设置界面中查看)、CPU 负载的传感器 ID，以及主机其他各项性能指标对应的 传感器 ID，点击 *确认* 关闭对话框
+
+.. image:: _static/librehardwaremonitor_dialog_xdial_config.png
+   :align: center
+   :scale: 80%
+   :class: border
+
+\
+
+点击菜单 *选项* → *xDial 性能监视* → *运行*，此时软件会尝试连接 xDial 设备。
+
+.. image:: _static/librehardwaremonitor_menu_xdial_run.png
+   :align: center
+   :scale: 80%
+   :class: border
+
+\
+
+同时，请确保设备的性能监视功能也在开启状态。
+
+
+.. |LibreHardwareMonitor_for_xDial.zip| raw:: html
+
+   <a href="https://gitee.com/r-cute/LibreHardwareMonitor_for_xDial/releases/latest" target="_blank">LibreHardwareMonitor_for_xDial.zip</a>
+
+
+.. |下载安装 .Net 4.7.2 运行环境| raw:: html
+
+   <a href="https://dotnet.microsoft.com/en-us/download/dotnet-framework/net47" target="_blank">下载安装 .Net 4.7.2 运行环境</a>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<html><script>location.pathname='xdial_cf_gallery';</script><body></body></html>