jcgoette / baby_buddy_homeassistant

This custom integration provides sensors for Baby Buddy API endpoints.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

baby_buddy_homeassistant

hacs_badge Code style: black Imports: isort

This custom integration allows you to monitor Baby Buddy data for your child within Home Assistant. It also allows you to start timers and add data entries from within Home Assistant.

Installation

HACS

  1. Navigate to integrations section.
  2. Click "Explore & Add Repositories" in the bottom right corner.
  3. Search for "Baby Buddy".
  4. Click "INSTALL THIS REPOSITORY IN HACS".
  5. Click "Install".

Configuration

Adding BabyBuddy to your Home Assistant instance can be done via the user interface. The below parameters are required.

Parameters

Name Optional Description
address no Host URL for your instance of Baby Buddy, without sub path
port no Host port (default = 8000)
path no Sub path of your Baby Buddy instance (default = "")
api_key no The API key from the user settings page on your instance of Baby Buddy

Options

The following options are available:

  • Temperature unit (Celsius or Fahrenheit)

  • Weight unit (kilogram, pound, or ounce)

  • Feeding amount volume unit (mL or fl. oz.)

  • Update interval in seconds (default = 60)

Integration Entities

This integration provides the following entities.

Sensors

  • A sensor for each child, with date of birth returned as state.

  • A sensor for each last data entry, including diaper_change, feeding, notes, sleep, temperature, tummy_time, temperature, and weight.

Switches

  • A switch is created for each child to handle its timer. Turning on the switch starts a new timer for the linked child. Turning off the switch deletes the timer. (check below for usage of timer.)

Timer notes

Feeding, Sleep, and Tummy time can be linked to a timer. If a timer is active you can add any of these entries and link it to the timer to automatically specify child, start time, and end time. It is important that the timer is active when the service is called.

Services

SERVICE ADD_CHILD

This service adds a new child. At least one child should be added to start seeing the different sensors and switches.

Service data attribute Optional Description
first_name no Baby's first name
last_name no Baby's last name
birth_date no Child's birth date in YYYY-MM-DD format

SERVICE ADD_BMI

This service adds a BMI entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
BMI no Specify BMI value (float)
date yes Specify BMI recording date (YYYY-MM-DD format, else today() will be used)
notes yes Add notes text to entry

SERVICE ADD_DIAPER_CHANGE

This service adds a diaper change entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
type yes Specify type of diaper. This can be Wet, Solid, or Wet and Solid.
time yes Specify diaper change time (must be in the past, else now() will be used)
color yes Specify diaper color. This can be Black, Brown , Green, or Yellow.
amount yes Add number of diapers
notes yes Add notes text to entry

SERVICE ADD_FEEDING

This service adds a feeding entry for your child. Feeding start/end/child fields can be linked to an active timer.

Service data attribute Optional Description
entity_id no entity_id for the timer switch linked to the child.
type no Specify type of feeding. Can be one of Breast milk, Formula, Fortified breast milk, or Solid food.
method no Specify method of feeding. Can be one of Bottle, Left breast, Right breast, Both breasts, Self fed, or Parent fed.
timer yes Set to True to use the currently active timer
start yes Specify start time (must be in the past, else now() will be used). This can be ignored if timer is used.
end yes Specify end time (must be in the past, else now() will be used). This can be ignored if timer is used.
amount yes Specify amount of feeding as an integer
notes yes Add notes text to entry

SERVICE ADD_HEAD_CIRCUMFERENCE

This service adds a head circumference entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
head_circumference no Specify head circumference value (float)
date yes Specify head circumference recording date (YYYY-MM-DD format, else today() will be used)
notes yes Add notes text to entry

SERVICE ADD_HEIGHT

This service adds a height entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
height no Specify height value (float)
date yes Specify height recording date (YYYY-MM-DD format, else today() will be used)
notes yes Add notes text to entry

SERVICE ADD_NOTE

This service adds a note entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
notes yes Add notes text to entry
time yes Specify notes recording time (must be in the past, else now() will be used)

SERVICE ADD_PUMPING

This service adds a pumping entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
amount no Specify amount of pumping as an integer
time yes Specify pumping recording time (must be in the past, else now() will be used)
notes yes Add notes text to entry

SERVICE ADD_SLEEP

This service adds a sleep entry for your child. Sleep start/end/child fields can be linked to an active timer.

Service data attribute Optional Description
entity_id no entity_id for the timer switch linked to the child
timer yes Set to True to use the currently active timer
start yes Specify start time (must be in the past, else now() will be used). This can be ignored if timer is used.
end yes Specify end time (must be in the past, else now() will be used). This can be ignored if timer is used.
notes yes Add notes text to entry

SERVICE ADD_TEMPERATURE

This service adds a temperature entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
temperature no Specify temperature value (float)
time yes Specify temperature recording time (must be in the past, else now() will be used)
notes yes Add notes text to entry

SERVICE ADD_TUMMY_TIME

This service adds a tummy time entry for your child. Tummy time start/end/child fields can be linked to an active timer.

Service data attribute Optional Description
entity_id no entity_id for the timer switch linked to the child
timer yes Set to True to use the currently active timer
start yes Specify start time (must be in the past, else now() will be used). This can be ignored if timer is used.
end yes Specify end time (must be in the past, else now() will be used). This can be ignored if timer is used.
milestone yes Add milestone text to entry

SERVICE ADD_WEIGHT

This service adds a weight entry for your child.

Service data attribute Optional Description
entity_id no entity_id for the child sensor
weight no Specify weight value (float)
date yes Specify weight recording date (YYYY-MM-DD format, else today() will be used)
notes yes Add notes text to entry

SERVICE DELETE_LAST_ENTRY

This service starts a new timer for specified child with optional starting time.

Service data attribute Optional Description
entity_id no entity_id for the child who's last entry will be deleted

SERVICE START_TIMER

This service starts a new timer for specified child with optional starting time.

Service data attribute Optional Description
entity_id no entity_id for the switch linked to the child
start yes Specify start time (must be in the past, else now() will be used)
name yes Optional name for new timer
ezoic increase your site revenue

About

This custom integration provides sensors for Baby Buddy API endpoints.

License:MIT License


Languages

Language:Python 100.0%