Git Product home page Git Product logo

yellow.home-assistant.io's Introduction

Home Assistant Yellow website

This is the source of the Yellow documentation website at yellow.home-assistant.io.

Setup

This website is built using 11ty. The website is automatically deployed using Netlify.

Development

The easiest way to edit the documentation is to open the environment in GitHub Codespaces. Codespaces work in your browser, no installation required.

  1. Further up on this page, select the green Code button.
  2. On the Codespaces tab, select Create codespace on main.
  3. Make your changes and push them.
  4. You are amazing! Thank you for contributing.

If you prefer to run this locally, the recommended development environment is Visual Studio Code. The repository uses Dev Containers. When opening a checked out version of this repository, make sure to open it in the Dev Container (Ctrl+Shift+P > Dev Containers: Open Folder in Container...)

If you prefer other editors, Dev Containers is an open standard and can be used with other editors. See containers.dev for more information on supported editors.

Preview

There is a pre-configured task to run a preview version of the website. Use Ctrl+Shift+P, and select Tasks: Run tasks.

yellow.home-assistant.io's People

Contributors

c0ffeeca7 avatar agners avatar dependabot[bot] avatar balloob avatar zsarnett avatar ludeeus avatar strugee avatar b-uwe avatar cogneato avatar benben avatar jkpe avatar jc2k avatar jwillikers avatar tommatheussen avatar puddly avatar

Stargazers

Dawid Dawidowicz avatar Dominik Antal avatar Alexander Salas Bastidas avatar George Kontridze avatar  avatar Donald Raecke avatar  avatar David Izada Rodriguez avatar Andreas Schroth avatar  avatar WebMark avatar Joseph Stewart avatar Steffen Lav avatar Bryden Wayne avatar  avatar Kyle Howells avatar Darren Darnell avatar  avatar  avatar William da Rosa Fröhlich avatar Marc Carran avatar Charith Madhuranga avatar  avatar

Watchers

 avatar Franck Nijhof avatar James Cloos avatar Donald Raecke avatar  avatar  avatar  avatar  avatar

yellow.home-assistant.io's Issues

Move Step 1 outisde of procedures

Currently we have up to three procedures, e.g. for Kit with NVMe:

  1. Install the Raspberry Pi CM4 Module
  2. Install NVMe drive
  3. Reassemble your Home Assistant Yellow
  4. Installing Home Assistant Software on Kit

That makes it awkward to have all the tools required part of the first procedure (also, it is wrong depending on the options selected).

Add a Required Tools thingy at the very top, outside of any procedure.

image

Feedback from Pilot Run

Setting up the hardware

  • Step 1: I grabbed a screwdriver while I didn’t need it. Add Optional before the text.
  • Step 2: A lot of people won’t do this.
  • Step 3: Removing the protective cover isn’t a step, maybe at the end? In the picture, you don’t see it, while it’s maybe wise to keep it till the end.
  • Step 3: I only removed the top part of the case. Should I also remove the bottom?
  • Step 5: CM4 click into place, make sure you do both.
  • Step 5: “The berry icon needs to be upside down” is nice, maybe start with that. Now I didn’t read it and just figured it out by myself.
  • Step 6: My heat pad was a bit smaller. Add a hint that this shouldn’t be a problem, right?
  • Step 6: Give a hint to remove both protective covers off the heat pad. People can be stupid.
  • Step 7: Installing the heat sink can be tricky in my experience. I would recommend pushing the pins in the heat sink before pushing them into the Yellow.
  • Step 12: how to know what the extrusion is?
  • Step 17: On PoE, you don’t have HA installed yet?

Installing Home Assistant Software on Kit

  • Step 10: Add PoE description
  • Step 13: Why do I need to press the red or blue button?

Design

Landing Page

Should not land on a guide
Land on a way to choose the correct guide

FAQ on CM4 Requirements

It would be great if the FAQ explained which CM4 SKUs one should use in what scenarios and if there any known issues with specific configurations.

For example:

  1. When using a Lite SKU, you will also need to have an SSD and follow these setup steps (add a link)
  2. If using lower RAM SKUs you should take the following into consideration... (Runs on 1GB yeah sure, but what RAM is recommended, or is required in certain scenarios like ESPHOME)
  3. Do you need WI-FI? Will the WI-FI even be used if you have it?

I notice some of this is on the how to find a CM4 page... but in the FAQ would be better.

Adjust FAQ about CM4 issues

Split no LED and red LED only. In the No LED case, add a side view and really put focus on alignment and check.

The Home Assisntant Yellow (with CM4) problem is solved, so the focus should be for Kit users (which seem to struggle as well).

Use red font for NVMe SSD list

Despite clear text above the list, some people interpret the list as known working... Let's use a red font to alert people that this is a negative list.

Improve ESD step

We should warn about ESD, even if people don't read it. It can also be about liability...

I suggest some improvements:

Change hint to:

  • Always: Touch working surface before touching electronics. This protects the components from the static electricity that can be naturally present.
  • Ideally: Use ESD protective equipment such as ESD table mats and grounding cords.

Dark mode

I would like to work on this issue. Can you please assign me this issue?

Adding UI

I would like to work on this issue. Can you please assign me this issue?

Radio LED behavior not documented

Yellow standard feedback

  • Step 2 Push the Ethernet cable into the jack until you hear a click change it to Plug in your Ethernet cable and make sure it is locked into place
  • Step 4 Once your Home Assistant Yellow has initialized, ... change it to Once your Home Assistant Yellow is finished downloading, ...

Please provide download link for installer

Please provide a link to, for example, https://github.com/NabuCasa/yellow-buildroot/releases so those who don't have a supported OS for rpi-imager may find the files and manually flash their install media.

Background, I use Fedora at home. Outside of forcing the package with alien, I can't install rpi-imager because it only provides packages for Ubuntu, Windows, and Mac. The only install instructions on the yellow.home-assistant.io site point to finding the images in rpi-imager.

Failed to forcing installation onto the NVMe SSD

Just got my yellow, CM4 with 32GB eMMC (CM4108032) and Kingsman KM600 128GB NVMe installed
Boot up with USB installer and waited for yellow light up constantly. Press the blue button.
After onboarding, everything still install on eMMC in cm4, 128GB NVMc can only be a data disk.
Any idea which step was wrong ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.