mirror of
https://github.com/blakeblackshear/frigate.git
synced 2024-11-21 19:07:46 +01:00
35 lines
36 KiB
HTML
35 lines
36 KiB
HTML
|
<!doctype html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
<meta name="generator" content="Docusaurus v2.0.0-alpha.70">
|
||
|
|
<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Frigate Blog RSS Feed">
|
||
|
|
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Frigate Blog Atom Feed"><title data-react-helmet="true">MQTT | Frigate</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="MQTT | Frigate"><meta data-react-helmet="true" name="description" content="These are the MQTT messages generated by Frigate. The default topic_prefix is frigate, but can be changed in the config file."><meta data-react-helmet="true" property="og:description" content="These are the MQTT messages generated by Frigate. The default topic_prefix is frigate, but can be changed in the config file."><meta data-react-helmet="true" property="og:url" content="https://blakeblackshear.github.io/frigate/usage/mqtt"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://blakeblackshear.github.io/frigate/usage/mqtt"><link rel="stylesheet" href="/styles.3cef2c0e.css">
|
||
|
|
<link rel="preload" href="/styles.9ee538de.js" as="script">
|
||
|
|
<link rel="preload" href="/runtime~main.fe1f2385.js" as="script">
|
||
|
|
<link rel="preload" href="/main.eeed996f.js" as="script">
|
||
|
|
<link rel="preload" href="/1.ae1576eb.js" as="script">
|
||
|
|
<link rel="preload" href="/2.0c8f52fa.js" as="script">
|
||
|
|
<link rel="preload" href="/24.22ef4830.js" as="script">
|
||
|
|
<link rel="preload" href="/935f2afb.73bfd95b.js" as="script">
|
||
|
|
<link rel="preload" href="/17896441.8d5dd138.js" as="script">
|
||
|
|
<link rel="preload" href="/a238e6ce.46f3fb71.js" as="script">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
|
|
<nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_11B0">Skip to main content</button></nav><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="/img/logo.svg" alt="Frigate" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/img/logo-dark.svg" alt="Frigate" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Frigate</strong></a><a class="navbar__item navbar__link" href="/">Docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/blakeblackshear/frigate" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_3NWk">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_3NWk">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/logo.svg" alt="Frigate" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/img/logo-dark.svg" alt="Frigate" class="themedImage_YANc themedImage--dark_3ARp navbar__logo"><strong class="navbar__title">Frigate</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/">Docs</a></li><li class="menu__list-item"><a href="https://github.com/blakeblackshear/frigate" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_vMrn"><div class="docSidebarContainer_3Ak5" role="complementary"><div class="sidebar_3gvy"><div class="menu menu--responsive thin-scrollbar menu_1yIk"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1CUI" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menuLinkText_yu3-">Frigate</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/">Features</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/how-it-works">How it works</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/hardware">Recommended hardware</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/installation">Installation</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/troubleshooting">Troubleshooting</a></li></ul></li><li class="menu__list-item"><a class="menu__link menuLinkText_yu3-">Configuration</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/configuration/index">Configuration</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/configuration/cameras">Cameras</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/configuration/optimizing">Optimizing performance</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/configur
|
||
|
|
"online": published when frigate is running (on startup)
|
||
|
|
"offline": published right before frigate stops</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="frigatecamera_nameobject_name"></a><code>frigate/<camera_name>/<object_name></code><a class="hash-link" href="#frigatecamera_nameobject_name" title="Direct link to heading">#</a></h3><p>Publishes the count of objects for the camera for use as a sensor in HomeAssistant.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="frigatezone_nameobject_name"></a><code>frigate/<zone_name>/<object_name></code><a class="hash-link" href="#frigatezone_nameobject_name" title="Direct link to heading">#</a></h3><p>Publishes the count of objects for the zone for use as a sensor in HomeAssistant.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="frigatecamera_nameobject_namesnapshot"></a><code>frigate/<camera_name>/<object_name>/snapshot</code><a class="hash-link" href="#frigatecamera_nameobject_namesnapshot" title="Direct link to heading">#</a></h3><p>Publishes a jpeg encoded frame of the detected object type. When the object is no longer detected, the highest confidence image is published or the original image
|
||
|
|
is published again.</p><p>The height and crop of snapshots can be configured in the config.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="frigateevents"></a><code>frigate/events</code><a class="hash-link" href="#frigateevents" title="Direct link to heading">#</a></h3><p>Message published for each changed event. The first message is published when the tracked object is no longer marked as a false_positive. When frigate finds a better snapshot of the tracked object or when a zone change occurs, it will publish a message with the same id. When the event ends, a final message is published with <code>end_time</code> set.</p><div class="mdxCodeBlock_1zKU"><div class="codeBlockContent_actS"><div tabindex="0" class="prism-code language-json codeBlock_tuNs thin-scrollbar"><div class="codeBlockLines_3uvA" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"type"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"update"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"> </span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">// new, update, or end</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"before"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"id"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"1607123955.475377-mxklsc"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"camera"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"front_door"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"frame_time"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">1607123961.837752</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"label"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"person"</span><span class="token punctuation" style="color:rgb(199, 146, 234)">,</span><span class="token plain"></span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token property">"top_score"</span><span class="token operator" style="color:rgb(137, 221, 255)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.958984375</span><span class="token punctua
|
||
|
|
<script src="/styles.9ee538de.js"></script>
|
||
|
|
<script src="/runtime~main.fe1f2385.js"></script>
|
||
|
|
<script src="/main.eeed996f.js"></script>
|
||
|
|
<script src="/1.ae1576eb.js"></script>
|
||
|
|
<script src="/2.0c8f52fa.js"></script>
|
||
|
|
<script src="/24.22ef4830.js"></script>
|
||
|
|
<script src="/935f2afb.73bfd95b.js"></script>
|
||
|
|
<script src="/17896441.8d5dd138.js"></script>
|
||
|
|
<script src="/a238e6ce.46f3fb71.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|