mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-03-30 05:13:40 +00:00
1 line
No EOL
8.3 KiB
JavaScript
1 line
No EOL
8.3 KiB
JavaScript
"use strict";(globalThis.webpackChunkdocs_split_user=globalThis.webpackChunkdocs_split_user||[]).push([[3976],{2053:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"intro","title":"User Documentation","description":"Welcome to the Tibber Prices custom integration for Home Assistant! This community-developed integration enhances your Home Assistant installation with detailed electricity price data from Tibber, featuring quarter-hourly precision, statistical analysis, and intelligent ratings.","source":"@site/docs/intro.md","sourceDirName":".","slug":"/intro","permalink":"/hass.tibber_prices/user/intro","draft":false,"unlisted":false,"editUrl":"https://github.com/jpawlowski/hass.tibber_prices/tree/main/docs/user/docs/intro.md","tags":[],"version":"current","lastUpdatedAt":1764985026000,"frontMatter":{"comments":false},"sidebar":"tutorialSidebar","next":{"title":"Installation","permalink":"/hass.tibber_prices/user/installation"}}');var r=i(4848),t=i(8453);const o={comments:!1},a="User Documentation",l={},c=[{value:"\ud83d\udcda Documentation",id:"-documentation",level:2},{value:"\ud83d\ude80 Quick Start",id:"-quick-start",level:2},{value:"\u2728 Key Features",id:"-key-features",level:2},{value:"\ud83d\udd17 Useful Links",id:"-useful-links",level:2},{value:"\ud83e\udd1d Need Help?",id:"-need-help",level:2}];function h(e){const s={a:"a",admonition:"admonition",h1:"h1",h2:"h2",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"user-documentation",children:"User Documentation"})}),"\n",(0,r.jsxs)(s.p,{children:["Welcome to the ",(0,r.jsx)(s.strong,{children:"Tibber Prices custom integration for Home Assistant"}),"! This community-developed integration enhances your Home Assistant installation with detailed electricity price data from Tibber, featuring quarter-hourly precision, statistical analysis, and intelligent ratings."]}),"\n",(0,r.jsx)(s.admonition,{title:"Not affiliated with Tibber",type:"info",children:(0,r.jsxs)(s.p,{children:["This is an independent, community-maintained custom integration. It is ",(0,r.jsx)(s.strong,{children:"not"})," an official Tibber product and is ",(0,r.jsx)(s.strong,{children:"not"})," affiliated with or endorsed by Tibber AS."]})}),"\n",(0,r.jsx)(s.h2,{id:"-documentation",children:"\ud83d\udcda Documentation"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/installation",children:"Installation"})})," - How to install via HACS and configure the integration"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/configuration",children:"Configuration"})})," - Setting up your Tibber API token and price thresholds"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/period-calculation",children:"Period Calculation"})})," - How Best/Peak Price periods are calculated and configured"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/sensors",children:"Sensors"})})," - Available sensors, their states, and attributes"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/dynamic-icons",children:"Dynamic Icons"})})," - State-based automatic icon changes"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/icon-colors",children:"Dynamic Icon Colors"})})," - Using icon_color attribute for color-coded dashboards"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/actions",children:"Actions"})})," - Custom actions (service endpoints) and how to use them"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/chart-examples",children:"Chart Examples"})})," - \u2728 ApexCharts visualizations with screenshots"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/automation-examples",children:"Automation Examples"})})," - Ready-to-use automation recipes"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/troubleshooting",children:"Troubleshooting"})})," - Common issues and solutions"]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"-quick-start",children:"\ud83d\ude80 Quick Start"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Install via HACS"})," (add as custom repository)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Add Integration"})," in Home Assistant \u2192 Settings \u2192 Devices & Services"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Enter Tibber API Token"})," (get yours at ",(0,r.jsx)(s.a,{href:"https://developer.tibber.com/",children:"developer.tibber.com"}),")"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Configure Price Thresholds"})," (optional, defaults work for most users)"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Start Using Sensors"})," in automations, dashboards, and scripts!"]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"-key-features",children:"\u2728 Key Features"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Quarter-hourly precision"})," - 15-minute intervals for accurate price tracking"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Statistical analysis"})," - Trailing/leading 24h averages for context"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Price ratings"})," - LOW/NORMAL/HIGH classification based on your thresholds"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Best/Peak hour detection"})," - Automatic detection of cheapest/peak periods with configurable filters (",(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/period-calculation",children:"learn how"}),")"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Beautiful ApexCharts"})," - Auto-generated chart configurations with dynamic Y-axis scaling (",(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/chart-examples",children:"see examples"}),")"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Chart metadata sensor"})," - Dynamic chart configuration for optimal visualization"]}),"\n",(0,r.jsxs)(s.li,{children:[(0,r.jsx)(s.strong,{children:"Multi-currency support"})," - EUR, NOK, SEK with proper minor units (ct, \xf8re, \xf6re)"]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"-useful-links",children:"\ud83d\udd17 Useful Links"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/jpawlowski/hass.tibber_prices",children:"GitHub Repository"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/jpawlowski/hass.tibber_prices/issues",children:"Issue Tracker"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://github.com/jpawlowski/hass.tibber_prices/releases",children:"Release Notes"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://community.home-assistant.io/",children:"Home Assistant Community"})}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"-need-help",children:"\ud83e\udd1d Need Help?"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["Check the ",(0,r.jsx)(s.a,{href:"/hass.tibber_prices/user/troubleshooting",children:"Troubleshooting Guide"})]}),"\n",(0,r.jsxs)(s.li,{children:["Search ",(0,r.jsx)(s.a,{href:"https://github.com/jpawlowski/hass.tibber_prices/issues",children:"existing issues"})]}),"\n",(0,r.jsxs)(s.li,{children:["Open a ",(0,r.jsx)(s.a,{href:"https://github.com/jpawlowski/hass.tibber_prices/issues/new",children:"new issue"})," if needed"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Note:"})," These guides are for end users. If you want to contribute to development, see the ",(0,r.jsx)(s.a,{href:"../development/",children:"Developer Documentation"}),"."]})]})}function d(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); |