Add hugo docs
This commit is contained in:
Andrej Friesen
parent
8d473183f9
commit
d800069531
|
|
@ -0,0 +1,14 @@
|
|||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
directory: "/docs"
|
||||
schedule:
|
||||
interval: daily
|
||||
time: '20:00'
|
||||
open-pull-requests-limit: 10
|
||||
- package-ecosystem: bundler
|
||||
directory: "/docs"
|
||||
schedule:
|
||||
interval: daily
|
||||
time: '20:00'
|
||||
open-pull-requests-limit: 10
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
name: github pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main # Set a branch that will trigger a deployment
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
|
||||
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v2
|
||||
with:
|
||||
hugo-version: '0.91.2'
|
||||
extended: true
|
||||
|
||||
# - name: Setup Node
|
||||
# uses: actions/setup-node@v3
|
||||
# with:
|
||||
# node-version: '16'
|
||||
# cache: 'npm'
|
||||
# The action defaults to search for the dependency file (package-lock.json,
|
||||
# npm-shrinkwrap.json or yarn.lock) in the repository root, and uses its
|
||||
# hash as a part of the cache key.
|
||||
# https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-data
|
||||
# cache-dependency-path: '**/package-lock.json'
|
||||
- name: Build
|
||||
working-directory: docs
|
||||
run: |
|
||||
npm install postcss-cli
|
||||
hugo --minify
|
||||
pwd
|
||||
ls -l
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
if: ${{ github.ref == 'refs/heads/main' }}
|
||||
with:
|
||||
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
|
||||
publish_dir: ./docs/public
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
|
||||
[submodule "themes/docsy"]
|
||||
path = themes/docsy
|
||||
url = https://github.com/google/docsy
|
||||
|
|
@ -0,0 +1 @@
|
|||
lts/*
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
FROM klakegg/hugo:ext-alpine
|
||||
|
||||
RUN apk add --no-cache git && \
|
||||
git config --global --add safe.directory /src
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
$primary: #000000;
|
||||
$secondary: #ffffff;
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
baseURL = "https://ajfriesen.github.io/pc-switch"
|
||||
title = "pc-switch"
|
||||
|
||||
# Language settings
|
||||
contentDir = "content/en"
|
||||
defaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir = false
|
||||
# Useful when translating.
|
||||
enableMissingTranslationPlaceholders = false
|
||||
|
||||
enableRobotsTXT = true
|
||||
|
||||
# Will give values to .Lastmod etc.
|
||||
enableGitInfo = true
|
||||
|
||||
# Comment out to enable taxonomies in Docsy
|
||||
# disableKinds = ["taxonomy", "taxonomyTerm"]
|
||||
|
||||
# You can add your own taxonomies
|
||||
[taxonomies]
|
||||
tag = "tags"
|
||||
category = "categories"
|
||||
|
||||
[params.taxonomy]
|
||||
# set taxonomyCloud = [] to hide taxonomy clouds
|
||||
taxonomyCloud = ["tags", "categories"]
|
||||
|
||||
# If used, must have same length as taxonomyCloud
|
||||
taxonomyCloudTitle = ["Tag Cloud", "Categories"]
|
||||
|
||||
# set taxonomyPageHeader = [] to hide taxonomies on the page headers
|
||||
taxonomyPageHeader = ["tags", "categories"]
|
||||
|
||||
|
||||
# Highlighting config
|
||||
pygmentsCodeFences = true
|
||||
pygmentsUseClasses = false
|
||||
# Use the new Chroma Go highlighter in Hugo.
|
||||
pygmentsUseClassic = false
|
||||
#pygmentsOptions = "linenos=table"
|
||||
# See https://help.farbox.com/pygments.html
|
||||
pygmentsStyle = "tango"
|
||||
|
||||
# Configure how URLs look like per section.
|
||||
[permalinks]
|
||||
blog = "/:section/:year/:month/:day/:slug/"
|
||||
|
||||
# Image processing configuration.
|
||||
[imaging]
|
||||
resampleFilter = "CatmullRom"
|
||||
quality = 75
|
||||
anchor = "smart"
|
||||
|
||||
[services]
|
||||
[services.googleAnalytics]
|
||||
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
|
||||
# id = ""
|
||||
|
||||
# Language configuration
|
||||
|
||||
[languages]
|
||||
[languages.en]
|
||||
title = "pc-switch"
|
||||
description = "Documentation about the pc-switch"
|
||||
languageName ="English"
|
||||
# Weight used for sorting.
|
||||
weight = 1
|
||||
|
||||
[markup]
|
||||
[markup.goldmark]
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
[markup.highlight]
|
||||
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
|
||||
style = "tango"
|
||||
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
|
||||
# guessSyntax = "true"
|
||||
|
||||
# Everything below this are Site Params
|
||||
|
||||
# Comment out if you don't want the "print entire section" link enabled.
|
||||
[outputs]
|
||||
section = ["HTML", "print", "RSS"]
|
||||
|
||||
[params]
|
||||
copyright = "Andrej Friesen"
|
||||
privacy_policy = ""
|
||||
|
||||
# First one is picked as the Twitter card image if not set on page.
|
||||
# images = ["images/project-illustration.png"]
|
||||
|
||||
# Menu title if your navbar has a versions selector to access old versions of your site.
|
||||
# This menu appears only if you have at least one [params.versions] set.
|
||||
version_menu = "Releases"
|
||||
|
||||
# Flag used in the "version-banner" partial to decide whether to display a
|
||||
# banner on every page indicating that this is an archived version of the docs.
|
||||
# Set this flag to "true" if you want to display the banner.
|
||||
archived_version = false
|
||||
|
||||
# The version number for the version of the docs represented in this doc set.
|
||||
# Used in the "version-banner" partial to display a version number for the
|
||||
# current doc set.
|
||||
version = "0.0"
|
||||
|
||||
# A link to latest version of the docs. Used in the "version-banner" partial to
|
||||
# point people to the main doc site.
|
||||
# url_latest_version = ""
|
||||
|
||||
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
|
||||
github_repo = "https://github.com/ajfriesen/pc-switch"
|
||||
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
|
||||
# github_project_repo = "https://github.com/ajfriesen/pc-switch"
|
||||
|
||||
# Specify a value here if your content directory is not in your repo's root directory
|
||||
github_subdir = "docs"
|
||||
|
||||
# Uncomment this if your GitHub repo does not have "main" as the default branch,
|
||||
# or specify a new value if you want to reference another branch in your GitHub links
|
||||
github_branch= "main"
|
||||
|
||||
# Google Custom Search Engine ID. Remove or comment out to disable search.
|
||||
gcs_engine_id = "d72aa9b2712488cc3"
|
||||
|
||||
# Enable Algolia DocSearch
|
||||
algolia_docsearch = false
|
||||
|
||||
# Enable Lunr.js offline search
|
||||
offlineSearch = false
|
||||
|
||||
# Enable syntax highlighting and copy buttons on code blocks with Prism
|
||||
prism_syntax_highlighting = true
|
||||
|
||||
# User interface configuration
|
||||
[params.ui]
|
||||
# Set to true to disable breadcrumb navigation.
|
||||
breadcrumb_disable = false
|
||||
# Set to true to disable the About link in the site footer
|
||||
footer_about_disable = true
|
||||
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
|
||||
navbar_logo = true
|
||||
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
|
||||
navbar_translucent_over_cover_disable = false
|
||||
# Enable to show the side bar menu in its compact state.
|
||||
sidebar_menu_compact = false
|
||||
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
|
||||
sidebar_search_disable = false
|
||||
|
||||
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
|
||||
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
|
||||
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
|
||||
# add "hide_feedback: true" to the page's front matter.
|
||||
[params.ui.feedback]
|
||||
enable = false
|
||||
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
|
||||
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
|
||||
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
|
||||
|
||||
# Adds a reading time to the top of each doc.
|
||||
# If you want this feature, but occasionally need to remove the Reading time from a single page,
|
||||
# add "hide_readingtime: true" to the page's front matter
|
||||
[params.ui.readingtime]
|
||||
enable = false
|
||||
|
||||
[params.links]
|
||||
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
|
||||
[[params.links.user]]
|
||||
name = "Newsletter"
|
||||
url = "https://www.ajfriesen.com/#/portal/signup/"
|
||||
icon = "fa fa-envelope"
|
||||
desc = "My newsletter from by blog"
|
||||
[[params.links.user]]
|
||||
name ="Twitter"
|
||||
url = "https://twitter.com/mr_ajfriesen"
|
||||
icon = "fab fa-twitter"
|
||||
desc = "Follow me on twitter!"
|
||||
[[params.links.user]]
|
||||
name = "Mastodon"
|
||||
url = "https://home.social/@ajfriesen"
|
||||
icon = "fab fa-mastodon"
|
||||
desc = "Follow me on Mastodon"
|
||||
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
|
||||
[[params.links.developer]]
|
||||
name = "GitHub"
|
||||
url = "https://github.com/ajfriesen/pc-switch"
|
||||
icon = "fab fa-github"
|
||||
desc = "Here you can find the repo"
|
||||
[[params.links.developer]]
|
||||
name = "Open Source Hardware Lab"
|
||||
url = "https://oshwlab.com/ajfriesen/pc-swtich"
|
||||
icon = "fa fa-microchip"
|
||||
desc = "Want to edit the pc-switch to your liking? Here can start from mine and build your own on top of it."
|
||||
|
||||
# hugo module configuration
|
||||
|
||||
[module]
|
||||
# uncomment line below for temporary local development of module
|
||||
# replacements = "github.com/google/docsy -> ../../docsy"
|
||||
[module.hugoVersion]
|
||||
extended = true
|
||||
min = "0.75.0"
|
||||
[[module.imports]]
|
||||
path = "github.com/google/docsy"
|
||||
disable = false
|
||||
[[module.imports]]
|
||||
path = "github.com/google/docsy/dependencies"
|
||||
disable = false
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
+++
|
||||
title = "pc-switch"
|
||||
linkTitle = "pc-switch"
|
||||
|
||||
+++
|
||||
|
||||
{{< blocks/cover title="The pc-switch" image_anchor="top" height="half" color="blue" >}}
|
||||
<div class="mx-auto">
|
||||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
|
||||
Build your own <i class="fas fa-arrow-alt-circle-right ml-2"></i>
|
||||
</a>
|
||||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
|
||||
ESPHome Webflasher <i class="fab fa-github ml-2 "></i>
|
||||
</a>
|
||||
<p class="lead mt-5">Control your PC - WITHOUT the cloud!</p>
|
||||
{{< blocks/link-down color="info" >}}
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
{{< /blocks/cover >}}
|
||||
|
||||
|
||||
{{% blocks/lead color="primary" %}}
|
||||
The pc-switch allows you to control your Desktop PC with Home Assistant.
|
||||
|
||||
Provides a single web UI providing visibility into porridge temperature, chair size, and bed softness metrics! You can even find out who's been eating **your** porridge.
|
||||
|
||||
{{% /blocks/lead %}}
|
||||
|
||||
{{< blocks/section color="dark" >}}
|
||||
{{% blocks/feature icon="fa-computer" title="Control your PC with Home Assistant!" %}}
|
||||
Native Home Assistant integration
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fa fa-cloud-bolt" title="No cloud!!" %}}
|
||||
You can control your PC even if the internet is down
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fa-regular fa-power-off" title="Turn your PC on/off" %}}
|
||||
Normally power on and off your PC
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fa-regular fa-arrow-rotate-right" title="Soft reset" %}}
|
||||
Toggle the reset button
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fa-regular fa-baseball-bat-ball" title="Hard reset" %}}
|
||||
Toggle a hard reset when the system froze
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fa fa-wave-square" title="Monitor your PC power state" %}}
|
||||
You can check if you PC is on or off via the Power LED front panel connector
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
{{% blocks/feature icon="fa fa-toggle-off" title="Keep your front IO" %}}
|
||||
You can still use your power and reset button
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
|
||||
{{< /blocks/section >}}
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Community
|
||||
menu:
|
||||
main:
|
||||
weight: 40
|
||||
---
|
||||
|
||||
<!--add blocks of content here to add more sections to the community page -->
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
title: "Contribution Guidelines"
|
||||
linkTitle: "Contribution Guidelines"
|
||||
weight: 10
|
||||
description: >
|
||||
How to contribute to the docs
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
These basic sample guidelines assume that your Docsy site is deployed using Netlify and your files are stored in GitHub. You can use the guidelines "as is" or adapt them with your own instructions: for example, other deployment options, information about your doc project's file structure, project-specific review guidelines, versioning guidelines, or any other information your users might find useful when updating your site. [Kubeflow](https://github.com/kubeflow/website/blob/master/README.md) has a great example.
|
||||
|
||||
Don't forget to link to your own doc repo rather than our example site! Also make sure users can find these guidelines from your doc repo README: either add them there and link to them from this page, add them here and link to them from the README, or include them in both locations.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
We use [Hugo](https://gohugo.io/) to format and generate our website, the
|
||||
[Docsy](https://github.com/google/docsy) theme for styling and site structure,
|
||||
and [Netlify](https://www.netlify.com/) to manage the deployment of the site.
|
||||
Hugo is an open-source static site generator that provides us with templates,
|
||||
content organisation in a standard directory structure, and a website generation
|
||||
engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
|
||||
|
||||
All submissions, including submissions by project members, require review. We
|
||||
use GitHub pull requests for this purpose. Consult
|
||||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
||||
information on using pull requests.
|
||||
|
||||
## Quick start with Netlify
|
||||
|
||||
Here's a quick guide to updating the docs. It assumes you're familiar with the
|
||||
GitHub workflow and you're happy to use the automated preview of your doc
|
||||
updates:
|
||||
|
||||
1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) on GitHub.
|
||||
1. Make your changes and send a pull request (PR).
|
||||
1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
|
||||
it's a work in progress. (**Don't** add the Hugo property
|
||||
"draft = true" to the page front matter, because that prevents the
|
||||
auto-deployment of the content preview described in the next point.)
|
||||
1. Wait for the automated PR workflow to do some checks. When it's ready,
|
||||
you should see a comment like this: **deploy/netlify — Deploy preview ready!**
|
||||
1. Click **Details** to the right of "Deploy preview ready" to see a preview
|
||||
of your updates.
|
||||
1. Continue updating your doc and pushing your changes until you're happy with
|
||||
the content.
|
||||
1. When you're ready for a review, add a comment to the PR, and remove any
|
||||
"WIP" markers.
|
||||
|
||||
## Updating a single page
|
||||
|
||||
If you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you:
|
||||
|
||||
1. Click **Edit this page** in the top right hand corner of the page.
|
||||
1. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
|
||||
1. Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.
|
||||
|
||||
## Previewing your changes locally
|
||||
|
||||
If you want to run your own local Hugo server to preview your changes as you work:
|
||||
|
||||
1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
|
||||
1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) repo into your own project, then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
|
||||
|
||||
```
|
||||
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
|
||||
```
|
||||
|
||||
1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
|
||||
1. Continue with the usual GitHub workflow to edit files, commit them, push the
|
||||
changes up to your fork, and create a pull request.
|
||||
|
||||
## Creating an issue
|
||||
|
||||
If you've found a problem in the docs, but you're not sure how to fix it yourself, please create an issue in the [Goldydocs repo](https://github.com/google/docsy-example/issues). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.
|
||||
|
||||
## Useful resources
|
||||
|
||||
* [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
|
||||
* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.
|
||||
* [Github Hello World!](https://guides.github.com/activities/hello-world/): A basic introduction to GitHub concepts and workflow.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
categories: []
|
||||
tags: []
|
||||
title: "How to build the pc-switch"
|
||||
linkTitle: "How to build"
|
||||
weight: 2
|
||||
description: >
|
||||
What sol?
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
For DIY you need a basic soldering setup:
|
||||
|
||||
- Soldering iron
|
||||
- solder
|
||||
- optional but highly recommended: A soldering helper/hand
|
||||
|
||||
## Parts needed for the PCB
|
||||
|
||||
- WEMOS D1 mini (The ESP8266-12F from AZDelivery is a popular clone here in Germany)
|
||||
- 2 x Optocoupler EL817
|
||||
- 2 x Resistor 220 Ohm
|
||||
- Pin header for power pins: 2x1, you can use straight or angled versions
|
||||
- Pin headers for front panel connectors: 3x2 pin headers, you can use straight or angled versions
|
||||
- Pin headers for motherboard:
|
||||
- 3x2 pin headers, you can use straight or angled versions
|
||||
|
||||
## Additional parts for connecting the pc-switch
|
||||
|
||||
- 6 x female-to-female jumper cables to connect to the motherboard
|
||||
- 6 x female-to-male jumper cables to connect to the front panel connectors
|
||||
- 2 x female-to-female jumper cables to connect to power (use USB or other pins from your motherboard which are always on)
|
||||
|
||||
|
||||
## Ordering the PCB
|
||||
|
||||
Download the Gerber file
|
||||
Got to https://cart.jlcpcb.com/quote
|
||||
Upload the file and adjust your order
|
||||
|
||||
|
||||
|
||||
|
||||
## Soldering
|
||||
Resistors can be soldered either way, you can not do anything wrong here.
|
||||
Optocouplers need a specific orientation. You need to align the small circles on the board with the circles on the optocoupler.
|
||||
|
||||
|
||||
|
||||
## Flashing the software
|
||||
|
||||
1. I think it goes without saying but you need Home Assistant running somewhere.
|
||||
|
||||
|
||||
2. Install the ESPHome Add-On:
|
||||
|
||||
[](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome)
|
||||
|
||||
|
||||
3. Plug in the device via USB to your PC or the PC which is running Home Assistant
|
||||
|
||||
4. Copy and paste the YAML from GitHub: https://github.com/ajfriesen/pc-switch
|
||||
|
||||
5. Now your pc-switch should pop up automatically in the device section
|
||||
|
||||
[](https://my.home-assistant.io/redirect/devices/)
|
||||
|
||||
## Connecting to a PC or Server
|
||||
|
||||
1. Check if your motherboard supports always-on USB and enable it if possible(sometimes this setting is in a really weird spot)
|
||||
2. Connect your pc-switch to some USB header for power. Check the pins on your motherboard manual. You just need to use 5V and GND. (If you don't have always-on power you can run a USB micro cable into your case as well)
|
||||
3. Connect Reset, Power and Power LED with your board.
|
||||
4. If you want to use the power button and power led on your PC case then connect those as well.
|
||||
|
||||
Now enjoy automating your PC.
|
||||
|
||||
- Turn it off or on at a specific time
|
||||
- Add another button (like the Aqara ones) to Home Assistant and use that for power on/off
|
||||
- Connect your voice assistant like Google Home to that switch with Home Assistant (That is what I did🙂)
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 180 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 140 KiB |
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: "Overview"
|
||||
linkTitle: "Overview"
|
||||
weight: 1
|
||||
description: >
|
||||
What is the pc-switch.
|
||||
---
|
||||
|
||||
## What is it?
|
||||
|
||||
A small PCB that can be connected between your PC front IO and motherboard/mainboard.
|
||||
|
||||
## What can it do?
|
||||
|
||||
- Power on/off (Shutdown)
|
||||
- Hard shutdown (5-second hold)
|
||||
- Reset
|
||||
- Monitor PC state (on/off)
|
||||
- Still be able to use the front panel connectors buttons for power, reset, and the power led.
|
||||
- Power with 2 header pins. Grab power from your motherboard USB or other connectors.
|
||||
## Why do I want it?
|
||||
|
||||
Help your user know if your project will help them. Useful information can include:
|
||||
|
||||
* **What is it good for?**: What types of problems does your project solve? What are the benefits of using it?
|
||||
|
||||
* **What is it not good for?**: For example, point out situations that might intuitively seem suited for your project, but aren't for some reason. Also mention known limitations, scaling issues, or anything else that might let your users know if the project is not for them.
|
||||
|
||||
* **What is it *not yet* good for?**: Highlight any useful features that are coming soon.
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
|
||||
---
|
||||
title: "Similar Products"
|
||||
linkTitle: "Similar Products"
|
||||
weight: 10
|
||||
description: >
|
||||
What can your user do with your project?
|
||||
---
|
||||
Silverstone has a couple of products that go in the same direction.
|
||||
|
||||
- Silverstone ES02-USB
|
||||
- Silverstone ES02-PCIE
|
||||
- Silverstone ES03-WiFi
|
||||
|
||||
The first 2 products work with a remote only.
|
||||
No easy integration is possible with Home Assistant other than adding an RF transmitter to your setup.
|
||||
|
||||
The third one needs a third-party app.
|
||||
So another app on your phone and an internet connection if I am not mistaken. Another cloud service probably will die in a few years and turn this device into e-waste afterward.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
|
||||
---
|
||||
title: "Documentation"
|
||||
linkTitle: "Documentation"
|
||||
weight: 20
|
||||
menu:
|
||||
main:
|
||||
weight: 20
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Search Results
|
||||
layout: search
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: ESP Web Tools installer
|
||||
linkTitle: Web Flasher
|
||||
menu:
|
||||
main:
|
||||
weight: 20
|
||||
|
||||
---
|
||||
<script
|
||||
type="module"
|
||||
src="https://unpkg.com/esp-web-tools@9/dist/web/install-button.js?module"
|
||||
></script>
|
||||
|
||||
|
||||
|
||||
{{< blocks/cover title="ESP Web Tools installer" image_anchor="bottom" height="min" >}}
|
||||
|
||||
<p class="lead mt-5">Connect your pc-switch with your pc and click connect to flash the firmware.
|
||||
</p>
|
||||
|
||||
<esp-web-install-button
|
||||
manifest="/pc-switch/firmware_build/manifest.json"
|
||||
></esp-web-install-button>
|
||||
|
||||
{{< /blocks/cover >}}
|
||||
|
||||
<!-- {{% blocks/lead %}}
|
||||
|
||||
An easy way to flash the pc-switch firmware
|
||||
|
||||
{{% /blocks/lead %}} -->
|
||||
|
||||
|
||||
<!-- {{< blocks/section >}}
|
||||
<div class="col-12">
|
||||
<h1 class="text-center">This is another section</h1>
|
||||
</div>
|
||||
|
||||
{{< /blocks/section >}} -->
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
version: "3.3"
|
||||
|
||||
services:
|
||||
|
||||
site:
|
||||
image: docsy/docsy-example
|
||||
build:
|
||||
context: .
|
||||
command: server
|
||||
ports:
|
||||
- "1313:1313"
|
||||
volumes:
|
||||
- .:/src
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
module github.com/google/docsy-example
|
||||
|
||||
go 1.12
|
||||
|
||||
require (
|
||||
github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f // indirect
|
||||
github.com/google/docsy v0.6.0
|
||||
github.com/twbs/bootstrap v4.6.2+incompatible // indirect
|
||||
)
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g=
|
||||
github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
|
||||
github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI=
|
||||
github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M=
|
||||
github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
|
||||
github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
|
||||
github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o=
|
||||
github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{{ define "main"}}
|
||||
<main id="main">
|
||||
<div>
|
||||
<h1 id="title">Not found</h1>
|
||||
<p>Oops! This page doesn't exist. Try going back to our <a href="{{ "/" | relURL }}">home page</a>.</p>
|
||||
|
||||
<p>You can learn how to make a 404 page like this in <a href="https://gohugo.io/templates/404/">Custom 404 Pages</a>.</p>
|
||||
</div>
|
||||
</main>
|
||||
{{ end }}
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
{
|
||||
"name": "tech-doc-hugo",
|
||||
"version": "0.0.1",
|
||||
"description": "Hugo theme for technical documentation.",
|
||||
"main": "none.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/google/docsy-example.git"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/google/docsy-example/issues"
|
||||
},
|
||||
"homepage": "https://github.com/google/docsy-example#readme",
|
||||
"dependencies": {
|
||||
"@mdi/font": "7.1.96"
|
||||
},
|
||||
"devDependencies": {
|
||||
"autoprefixer": "^10.4.0",
|
||||
"postcss": "^8.3.7",
|
||||
"postcss-cli": "^9.0.2"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
"name": "pc-switch",
|
||||
"version": "1.0.0",
|
||||
"home_assistant_domain": "esphome",
|
||||
"funding_url": "https://www.ajfriesen.com/#/portal/signup/",
|
||||
"builds": [
|
||||
{
|
||||
"chipFamily": "ESP8266",
|
||||
"parts": [
|
||||
{ "path": "pc-switch.bin", "offset": 0 }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue