Files
home-information/docs/GettingStarted.md
Tony C 835a33c8a9 Updated documentation screenshots (#230)
* Updated all screenshots for most recent UI changes.
* Removed bad hass module tests.
2025-09-25 17:23:19 -05:00

7.8 KiB

Home Information Logo

Getting Started

Once successfully running (see the Installation Page), you will be greeted with:

Home Information Start Page

Choose which home type you want to use. If you choose "Single Story", you will see this initial screen with some common household items pre-populated.

initial-view-1024x768

These provide defaults to get started quickly. You can modify and customize as much as you want after this.

Adding Information

To core feature of Home Information is managing information about your home and the things in it. To add information, tap on any of the items and you will see the main information view/edit dialog. Initially, it looks like this:

item-edit-modal-empty-1024x768

Use the "Add Info" button to add some information about the item. Or use the "Add File" button to upload a document:

item-edit-add-info-1024x768   item-edit-add-file-1024x768

Some information may not be associated with an individual item, but the home overall. For that, use the top-right button to add the information to the home itself.

location-edit-modal-1024x768 location-edit-modal-1024x768

Multiple Spaces

If you have a multi-story house, basement, attic or even another vacation home or second property, you can create a different "space" for that. Here we have an extra space defined for the attic.

spaces-dropdown-1024x768   view-second-space-1024x768

Collections

Not everything in your home has a well defined location, so use the "collections" bottom buttons for those items and you can choose whether you prefer a list of grid layout.

collections-buttons

collections-grid-1024x768 & nbsp; collections-list-1024x768

Weather

There are some default weather integrations which also provide weather alerts. Tap on the weather information to see more details.

weather-details-1024x768   weather-forecast-1024x768

Seen sunrise times, sunset, moon phase, weather history and more.

astronomical-details-1024x768   weather-history-1024x768

Controls and Settings

Control alert sounds, screen brightness and lock your screen. The alerts and display keep running so you do not miss anything.

bottom-right-buttons-1024x768

For accurate weather and time, be sure to set your timezone and geographic location in the configuration pages.

console-settings-page-1024x768

Layout Editing

You have full control of the layout of your items and the background image. These are all managed by choosing "EDIT" and entering "Editing Mode".

edit-button edit-mode-1024x768

The Editing Page has many details on how to use the editor.

Integrations

For smart home device automation, go to the configuration area to enable one of the current integrations (e.g., Home Assistant).

integrations-page-empty-1024x768   integrations-enable-modal-1024x768

After enabled, you can import all the items to add them to your views and collections.

integrations-page-view-1024x768 integrations-sync-result-1024x768

See the Integrations Page for more details.

Cameras

If the integation provides cameras with video feeds (e.g., ZoneMinder), the cameras will appear in the side bar for easy access to their streams and for browsing the video stream history from past motion events.

video-stream-live-1024x768.png   video-stream-history-1024x768.png

Alert Triggering Rules and Security Modes

By default, if you have motion sensors, open/close sensors, camera motion, etc. the integration item import automatically creates alert triggering rules. You can view, refine and manage these in the configuration pages.

trigger-rules-1024x768

The triggering rules allows you to target different "security modes" for better control of what alerts and when.

security-modes

Alert Areas

In the editor, you can define areas and associate it with a device, like a camera. Then, if the camera detects motion, both the camera and the area will be highlighted.

camera-area-idle-1024x768.png   camera-area-active-1024x768.png

The highlighting will change color over time so you can see what is currently alarming, recently alarmed or what was active in the near past.

camera-area-recent-1024x768.png   camera-area-past-1024x768.png

Additional Details

Custom Background Images

In the editor, you can swap out the default property/house images for your own custom images. See the Custom Background Image Page for more details.

Alert Sounds

For features that use sounds (e.g., alerts), this allows toggling to mute and unmute. The alert sounds are considered "auto-play" by browsers, so you may need to allow this in the browser in order to hear the alert sounds. If you see "blocked' on this button, click it to see more info about fixing it.

Locking Feature

When visitors are in your house, be they friends, acquaintances, service or maintenance people, you may want to temporarily lock the screen so they cannot access the information you've stored. To unlock, it uses a password you set the first time you lock the screen. This is is just a light security convenience against casual snooping. Locking the device itself is better protection.