From d9795556c103b79db1a88b21c623faa12febfa0f Mon Sep 17 00:00:00 2001 From: "Christopher C. Wells" Date: Sun, 19 Mar 2023 16:34:53 -0700 Subject: [PATCH] Document Home Assistant as a deployment method --- README.md | 40 +++++++++++++++++++++++++++++----------- docs/setup/deployment.md | 13 +++++++++++++ 2 files changed, 42 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a8bb480b..8b1a9ca2 100644 --- a/README.md +++ b/README.md @@ -86,21 +86,39 @@ This is a non-exhaustive list of neat projects and blog posts that either extend or use Baby Buddy in fun ways. If you have a project to share please open a PR adding it here or reach out via GitHub Issues or Discussions or on Gitter! -- [Home Assistant integration](https://github.com/jcgoette/baby_buddy_homeassistant) -- [Home Assistant Addon (host Baby Buddy on your Home Assistant)](https://github.com/OttPeterR/addon-babybuddy) -- [Baby Buddy and Home Assistant](https://martinnoah.com/babybuddy-and-home-assistant.html) (how-to guide) -- [Bottle Scale for BabyBuddy and Home Assistant with ESPHome](https://github.com/sfgabe/OITProjects/tree/master/BabyBuddy_ESP_HASS) +### Smart home + +- [Home Assistant Addon](https://github.com/OttPeterR/addon-babybuddy) (host Baby Buddy on Home Assistant) +- [Home Assistant integration](https://github.com/jcgoette/baby_buddy_homeassistant) (monitor and use Baby Buddy from Home Assistant) +- [How to Setup Baby Buddy in Home Assistant](https://smarthomescene.com/guides/how-to-setup-baby-buddy-in-home-assistant/) +- [Baby Buddy and Home Assistant](https://martinnoah.com/babybuddy-and-home-assistant.html) - [Alexa skill](https://github.com/babybuddy/babybuddy-alexa-skill) -- [Sandstorm app](https://github.com/babybuddy/babybuddy-sandstorm) -- [iOS shortcuts](https://github.com/babybuddy/babybuddy/discussions/300) -- Newborn parenting software - [part 1](https://lutzky.net/2021/10/03/software-parenting-1/), [part 2](https://lutzky.net/2021/10/05/software-parenting-2/), [part 3](https://lutzky.net/2021/10/10/software-parenting-3/) (API, buttons, LCD information screen!) -- [Quick Entry Keypad (ESP8266)](https://github.com/sfgabe/OITProjects/tree/master/Baby_Buddy_Keypad) for BabyBuddy and Home Assistant with ESPHome + +### Hardware + +- [Bottle Scale for BabyBuddy and Home Assistant with ESPHome](https://github.com/sfgabe/OITProjects/tree/master/BabyBuddy_ESP_HASS) +- [Quick Entry Keypad (ESP8266)](https://github.com/sfgabe/OITProjects/tree/master/Baby_Buddy_Keypad) - [Baby Buddy Keypad (ESP32)](https://github.com/jeroenterheerdt/Baby-Buddy-Keypad) - [BabyScout](https://github.com/MikeSchapp/BabyScout) - Keypad for recording diaper changes, feedings and sleep to BabyBuddy -- [Baby Buddy: Keep Records of Your Child/Baby's Growth and Activities](https://www.youtube.com/watch?v=sO6rjn2s6-k) (video) -- [Convert exported data from "Baby tracker - feeding, sleep and diaper" mobile app to Baby Buddy](https://github.com/babybuddy/babybuddy/discussions/424) -- [Grafana Dashboard](https://github.com/babybuddy/babybuddy/discussions/607) + +### Mobile + - [Baby Buddy for Android](https://play.google.com/store/apps/details?id=eu.pkgsoftware.babybuddywidgets) ([Source](https://github.com/MrApplejuice/BabyBuddyAndroid/)) +- [iOS shortcuts](https://github.com/babybuddy/babybuddy/discussions/300) +- [Convert exported data from "Baby tracker - feeding, sleep and diaper" mobile app to Baby Buddy](https://github.com/babybuddy/babybuddy/discussions/424) + +### Videos + +- [Baby Buddy: Keep Records of Your Child/Baby's Growth and Activities](https://www.youtube.com/watch?v=sO6rjn2s6-k) + +### Other + +- [Grafana Dashboard](https://github.com/babybuddy/babybuddy/discussions/607) +- [Sandstorm app](https://github.com/babybuddy/babybuddy-sandstorm) +- Newborn parenting software series (API, buttons, LCD information screen!) + - [part 1](https://lutzky.net/2021/10/03/software-parenting-1/) + - [part 2](https://lutzky.net/2021/10/05/software-parenting-2/) + - [part 3](https://lutzky.net/2021/10/10/software-parenting-3/) ## Reporting Vulnerabilities diff --git a/docs/setup/deployment.md b/docs/setup/deployment.md index 4f3fbb4f..b0f07b56 100644 --- a/docs/setup/deployment.md +++ b/docs/setup/deployment.md @@ -40,6 +40,19 @@ export DJANGO_SETTINGS_MODULE="babybuddy.settings.base" python3 /app/babybuddy/manage.py clearsessions ``` +## Home Assistant + +[Home Assistant](https://www.home-assistant.io/) is an open source home automation tool +that can be used to host and control Baby Buddy. An existing Home Assistant installation +is required to use this method. + +See the community-maintained [Baby Buddy Home Assistant Addon](https://github.com/OttPeterR/addon-babybuddy) +for installation instructions and then review the community-maintained [Baby Buddy Home Assistant integration](https://github.com/jcgoette/baby_buddy_homeassistant) +for added integrations with the base Home Assistant system. + +See also [How to Setup Baby Buddy in Home Assistant](https://smarthomescene.com/guides/how-to-setup-baby-buddy-in-home-assistant/) +from Smart Home Scene for more detailed installation and configuration instructions. + ## Clever Cloud To deploy on [Clever Cloud](https://www.clever-cloud.com), log in to your