mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
187 lines
19 KiB
HTML
187 lines
19 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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>esp-nimble-cpp / NimBLE-Arduino: src/NimBLE2904.h Source File</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
|
|
 <span id="projectnumber">1.3.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_nim_b_l_e2904_8h_source.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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">NimBLE2904.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * NimBLE2904.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Created: on March 13, 2020</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author H2zero</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Originally:</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * BLE2904.h</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Created on: Dec 23, 2017</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Author: kolban</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef MAIN_NIMBLE2904_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define MAIN_NIMBLE2904_H_</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "sdkconfig.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "NimBLEDescriptor.h"</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">struct </span>BLE2904_Data {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  uint8_t m_format;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  int8_t m_exponent;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  uint16_t m_unit; <span class="comment">// See https://www.bluetooth.com/specifications/assigned-numbers/units</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  uint8_t m_namespace;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  uint16_t m_description;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> } __attribute__((packed));</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_nim_b_l_e2904.html"> 43</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e2904.html">NimBLE2904</a>: <span class="keyword">public</span> <a class="code" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="class_nim_b_l_e2904.html">NimBLE2904</a>(<a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacterisitic = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_BOOLEAN = 1;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT2 = 2;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT4 = 3;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT8 = 4;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT12 = 5;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT16 = 6;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT24 = 7;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT32 = 8;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT48 = 9;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT64 = 10;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UINT128 = 11;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT8 = 12;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT12 = 13;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT16 = 14;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT24 = 15;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT32 = 16;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT48 = 17;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT64 = 18;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SINT128 = 19;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_FLOAT32 = 20;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_FLOAT64 = 21;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SFLOAT16 = 22;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_SFLOAT32 = 23;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_IEEE20601 = 24;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UTF8 = 25;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_UTF16 = 26;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <span class="keyword">const</span> uint8_t FORMAT_OPAQUE = 27;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">setDescription</a>(uint16_t);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">setExponent</a>(int8_t exponent);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">setFormat</a>(uint8_t format);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">setNamespace</a>(uint8_t namespace_value);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">setUnit</a>(uint16_t unit);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  BLE2904_Data m_data;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> }; <span class="comment">// BLE2904</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLE2904_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html"><div class="ttname"><a href="class_nim_b_l_e2904.html">NimBLE2904</a></div><div class="ttdoc">Descriptor for Characteristic Presentation Format.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.h:43</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html_a2206274c217d43a8ba121e1d279f8962"><div class="ttname"><a href="class_nim_b_l_e2904.html#a2206274c217d43a8ba121e1d279f8962">NimBLE2904::setNamespace</a></div><div class="ttdeci">void setNamespace(uint8_t namespace_value)</div><div class="ttdoc">Set the namespace.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:73</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html_a498c863cb3fbf92eecc23f9f8856037c"><div class="ttname"><a href="class_nim_b_l_e2904.html#a498c863cb3fbf92eecc23f9f8856037c">NimBLE2904::setDescription</a></div><div class="ttdeci">void setDescription(uint16_t)</div><div class="ttdoc">Set the description.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:46</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html_ab1c53f99246f67dca1d63b812bef631d"><div class="ttname"><a href="class_nim_b_l_e2904.html#ab1c53f99246f67dca1d63b812bef631d">NimBLE2904::setExponent</a></div><div class="ttdeci">void setExponent(int8_t exponent)</div><div class="ttdoc">Set the exponent.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:55</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html_ab7f21651b4493fd3daaa0f1545032ff1"><div class="ttname"><a href="class_nim_b_l_e2904.html#ab7f21651b4493fd3daaa0f1545032ff1">NimBLE2904::setFormat</a></div><div class="ttdeci">void setFormat(uint8_t format)</div><div class="ttdoc">Set the format.</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:64</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e2904_html_ad0cf78a2a1c3418be9a39beaa0c826ee"><div class="ttname"><a href="class_nim_b_l_e2904.html#ad0cf78a2a1c3418be9a39beaa0c826ee">NimBLE2904::setUnit</a></div><div class="ttdeci">void setUnit(uint16_t unit)</div><div class="ttdoc">Set the units for this value. It should be one of the encoded values defined here: https://www....</div><div class="ttdef"><b>Definition:</b> NimBLE2904.cpp:84</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></div><div class="ttdoc">A model of a BLE descriptor.</div><div class="ttdef"><b>Definition:</b> NimBLEDescriptor.h:44</div></div>
|
|
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
|
|
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLE2904.h</b></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.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|