539 lines
26 KiB
HTML
539 lines
26 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: PagerClient Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_pager_client.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_pager_client-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PagerClient Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Client for Pager communication.
|
|
<a href="class_pager_client.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_pager_8h_source.html">Pager.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9f978120467b13104fb356e9b7d855ec" id="r_a9f978120467b13104fb356e9b7d855ec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
|
|
<tr class="memdesc:a9f978120467b13104fb356e9b7d855ec"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a9f978120467b13104fb356e9b7d855ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a1dc569f9b60b0ddd6ead7af5a8244f" id="r_a1a1dc569f9b60b0ddd6ead7af5a8244f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#a1a1dc569f9b60b0ddd6ead7af5a8244f">begin</a> (float base, uint16_t speed, bool invert=false, uint16_t shift=RADIOLIB_PAGER_FREQ_SHIFT_HZ)</td></tr>
|
|
<tr class="memdesc:a1a1dc569f9b60b0ddd6ead7af5a8244f"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <br /></td></tr>
|
|
<tr class="separator:a1a1dc569f9b60b0ddd6ead7af5a8244f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f9af4c0a5c2e9de7cdfa1a907479111" id="r_a8f9af4c0a5c2e9de7cdfa1a907479111"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">sendTone</a> (uint32_t addr)</td></tr>
|
|
<tr class="memdesc:a8f9af4c0a5c2e9de7cdfa1a907479111"><td class="mdescLeft"> </td><td class="mdescRight">Method to send a tone-only alert to a destination pager. <br /></td></tr>
|
|
<tr class="separator:a8f9af4c0a5c2e9de7cdfa1a907479111"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbab4e162a5719bd4407a42a85d26ff6" id="r_adbab4e162a5719bd4407a42a85d26ff6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#adbab4e162a5719bd4407a42a85d26ff6">transmit</a> (const char *str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</td></tr>
|
|
<tr class="memdesc:adbab4e162a5719bd4407a42a85d26ff6"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <br /></td></tr>
|
|
<tr class="separator:adbab4e162a5719bd4407a42a85d26ff6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cd7dd862fa437658acdbd8147083a08" id="r_a8cd7dd862fa437658acdbd8147083a08"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#a8cd7dd862fa437658acdbd8147083a08">transmit</a> (const uint8_t *data, size_t len, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</td></tr>
|
|
<tr class="memdesc:a8cd7dd862fa437658acdbd8147083a08"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Will transmit arbitrary binary data. <br /></td></tr>
|
|
<tr class="separator:a8cd7dd862fa437658acdbd8147083a08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac232570ac012ff315a1971ab0422fed3" id="r_ac232570ac012ff315a1971ab0422fed3"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">startReceive</a> (uint32_t pin, uint32_t addr, uint32_t mask=0xFFFFF)</td></tr>
|
|
<tr class="memdesc:ac232570ac012ff315a1971ab0422fed3"><td class="mdescLeft"> </td><td class="mdescRight">Start reception of POCSAG packets. <br /></td></tr>
|
|
<tr class="separator:ac232570ac012ff315a1971ab0422fed3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c0f13846fbc333a35a16a98b6575ca6" id="r_a9c0f13846fbc333a35a16a98b6575ca6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#a9c0f13846fbc333a35a16a98b6575ca6">startReceive</a> (uint32_t pin, uint32_t *addrs, uint32_t *masks, size_t numAddress)</td></tr>
|
|
<tr class="memdesc:a9c0f13846fbc333a35a16a98b6575ca6"><td class="mdescLeft"> </td><td class="mdescRight">Start reception of POCSAG packets for multiple addresses and masks. <br /></td></tr>
|
|
<tr class="separator:a9c0f13846fbc333a35a16a98b6575ca6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec073fa9e5adcff9730482d9583715e9" id="r_aec073fa9e5adcff9730482d9583715e9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">available</a> ()</td></tr>
|
|
<tr class="memdesc:aec073fa9e5adcff9730482d9583715e9"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer! <br /></td></tr>
|
|
<tr class="separator:aec073fa9e5adcff9730482d9583715e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2c6132819a84712b929c0bb22ba172b" id="r_ad2c6132819a84712b929c0bb22ba172b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">readData</a> (uint8_t *data, size_t *len, uint32_t *addr=NULL)</td></tr>
|
|
<tr class="memdesc:ad2c6132819a84712b929c0bb22ba172b"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <br /></td></tr>
|
|
<tr class="separator:ad2c6132819a84712b929c0bb22ba172b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Client for Pager communication. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9f978120467b13104fb356e9b7d855ec" name="a9f978120467b13104fb356e9b7d855ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f978120467b13104fb356e9b7d855ec">◆ </a></span>PagerClient()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PagerClient::PagerClient </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
|
<td class="paramname"><em>phy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> communication. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aec073fa9e5adcff9730482d9583715e9" name="aec073fa9e5adcff9730482d9583715e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aec073fa9e5adcff9730482d9583715e9">◆ </a></span>available()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t PagerClient::available </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer! </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of available batches. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a1dc569f9b60b0ddd6ead7af5a8244f" name="a1a1dc569f9b60b0ddd6ead7af5a8244f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a1dc569f9b60b0ddd6ead7af5a8244f">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>invert</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>shift</em> = <code>RADIOLIB_PAGER_FREQ_SHIFT_HZ</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>Base (center) frequency to be used in MHz. </td></tr>
|
|
<tr><td class="paramname">speed</td><td>Bit rate to use in bps. Common POCSAG decoders can receive 512, 1200 and 2400 bps. </td></tr>
|
|
<tr><td class="paramname">invert</td><td>Enable frequency inversion. Disabled by default (high frequency is digital 0). </td></tr>
|
|
<tr><td class="paramname">shift</td><td>Set custom frequency shift, defaults to 4500 Hz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2c6132819a84712b929c0bb22ba172b" name="ad2c6132819a84712b929c0bb22ba172b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2c6132819a84712b929c0bb22ba172b">◆ </a></span>readData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::readData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>addr</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data that was received after calling startReceive method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received message. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Pointer to variable holding the number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. Upon completion, the number of bytes received will be written to this variable. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Pointer to variable holding the address of the received pager message. Set to NULL to not retrieve address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f9af4c0a5c2e9de7cdfa1a907479111" name="a8f9af4c0a5c2e9de7cdfa1a907479111"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f9af4c0a5c2e9de7cdfa1a907479111">◆ </a></span>sendTone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::sendTone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to send a tone-only alert to a destination pager. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">addr</td><td>Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c0f13846fbc333a35a16a98b6575ca6" name="a9c0f13846fbc333a35a16a98b6575ca6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c0f13846fbc333a35a16a98b6575ca6">◆ </a></span>startReceive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>addrs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>masks</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>numAddress</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start reception of POCSAG packets for multiple addresses and masks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to receive digital data on (e.g., DIO2 for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a>). </td></tr>
|
|
<tr><td class="paramname">addrs</td><td>Array of addresses to receive. </td></tr>
|
|
<tr><td class="paramname">masks</td><td>Array of address masks to use for filtering. Masks will be applied to corresponding addresses in addr array. </td></tr>
|
|
<tr><td class="paramname">numAddress</td><td>Number of addresses/masks to match. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac232570ac012ff315a1971ab0422fed3" name="ac232570ac012ff315a1971ab0422fed3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac232570ac012ff315a1971ab0422fed3">◆ </a></span>startReceive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>mask</em> = <code>0xFFFFF</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start reception of POCSAG packets. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin to receive digital data on (e.g., DIO2 for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a>). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address of this "pager". Allowed values are 0 to 2097151 - values above 2000000 are reserved. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>Address filter mask - set individual bits to enable or disable match on that bit of the address. Set to 0xFFFFF (all bits checked) by default. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adbab4e162a5719bd4407a42a85d26ff6" name="adbab4e162a5719bd4407a42a85d26ff6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adbab4e162a5719bd4407a42a85d26ff6">◆ </a></span>transmit() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>encoding</em> = <code>RADIOLIB_PAGER_BCD</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>function</em> = <code>RADIOLIB_PAGER_FUNC_AUTO</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>C-string transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. </td></tr>
|
|
<tr><td class="paramname">encoding</td><td>Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD. </td></tr>
|
|
<tr><td class="paramname">function</td><td>bits (NUMERIC, TONE, ACTIVATION, ALPHANUMERIC). Allowed values 0 to 3. Defaults to auto select by specified encoding </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8cd7dd862fa437658acdbd8147083a08" name="a8cd7dd862fa437658acdbd8147083a08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8cd7dd862fa437658acdbd8147083a08">◆ </a></span>transmit() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PagerClient::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>encoding</em> = <code>RADIOLIB_PAGER_BCD</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>function</em> = <code>RADIOLIB_PAGER_FUNC_AUTO</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary transmit method. Will transmit arbitrary binary data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. </td></tr>
|
|
<tr><td class="paramname">encoding</td><td>Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD. </td></tr>
|
|
<tr><td class="paramname">function</td><td>bits (NUMERIC, TONE, ACTIVATION, ALPHANUMERIC). Allowed values 0 to 3. Defaults to auto select by specified encoding </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/protocols/Pager/<a class="el" href="_pager_8h_source.html">Pager.h</a></li>
|
|
<li>src/protocols/Pager/<b>Pager.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_pager_client.html">PagerClient</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|