/usr/share/doc/python-can-doc/html/bcm.html is in python-can-doc 2.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Broadcast Manager — can 1.5.2 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.5.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CAN Interface Modules" href="interfaces.html" />
<link rel="prev" title="Listeners" href="listeners.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="broadcast-manager">
<h1>Broadcast Manager<a class="headerlink" href="#broadcast-manager" title="Permalink to this headline">¶</a></h1>
<p>The broadcast manager isn’t yet supported by all interfaces.
Currently SockerCAN and IXXAT are supported at least partially.
It allows the user to setup periodic message jobs.</p>
<p>If periodic transmission is not supported natively, a software thread based
scheduler is used as a fallback.</p>
<p>This example shows the ctypes socketcan using the broadcast manager:</p>
<div class="section" id="functional-api">
<h2>Functional API<a class="headerlink" href="#functional-api" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="can.send_periodic">
<code class="descclassname">can.</code><code class="descname">send_periodic</code><span class="sig-paren">(</span><em>bus</em>, <em>message</em>, <em>period</em><span class="sig-paren">)</span><a class="headerlink" href="#can.send_periodic" title="Permalink to this definition">¶</a></dt>
<dd><p>Send a message every <cite>period</cite> seconds on the given channel.</p>
</dd></dl>
</div>
<div class="section" id="class-based-api">
<h2>Class based API<a class="headerlink" href="#class-based-api" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="can.CyclicSendTaskABC">
<em class="property">class </em><code class="descclassname">can.</code><code class="descname">CyclicSendTaskABC</code><span class="sig-paren">(</span><em>message</em>, <em>period</em><span class="sig-paren">)</span><a class="headerlink" href="#can.CyclicSendTaskABC" title="Permalink to this definition">¶</a></dt>
<dd><p>Message send task with defined period</p>
</dd></dl>
<dl class="class">
<dt id="can.MultiRateCyclicSendTaskABC">
<em class="property">class </em><code class="descclassname">can.</code><code class="descname">MultiRateCyclicSendTaskABC</code><span class="sig-paren">(</span><em>channel</em>, <em>message</em>, <em>count</em>, <em>initial_period</em>, <em>subsequent_period</em><span class="sig-paren">)</span><a class="headerlink" href="#can.MultiRateCyclicSendTaskABC" title="Permalink to this definition">¶</a></dt>
<dd><p>Exposes more of the full power of the TX_SETUP opcode.</p>
<p>Transmits a message <cite>count</cite> times at <cite>initial_period</cite> then
continues to transmit message at <cite>subsequent_period</cite>.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Broadcast Manager</a><ul>
<li><a class="reference internal" href="#functional-api">Functional API</a></li>
<li><a class="reference internal" href="#class-based-api">Class based API</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="api.html">Library API</a><ul>
<li>Previous: <a href="listeners.html" title="previous chapter">Listeners</a></li>
<li>Next: <a href="interfaces.html" title="next chapter">CAN Interface Modules</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2018, Brian Thorne et al..
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
</body>
</html>
|