361 lines
42 KiB
HTML
361 lines
42 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.8.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Firmata firmware for Arduino: FirmataDefines.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="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">Firmata firmware for Arduino
|
|
</div>
|
|
<div id="projectbrief">Firmata is a protocol for communicating with microcontrollers from software on a host computer</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<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');
|
|
/* @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 -->
|
|
<!-- 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">FirmataDefines.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"> FirmataDefines.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (c) 2006-2008 Hans-Christoph Steiner. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (C) 2009-2016 Jeff Hoefs. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</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"> See file LICENSE.txt for further informations on licensing terms.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef FirmataDefines_h</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define FirmataDefines_h</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "FirmataConstants.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* Version numbers for the Firmata library.</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * The firmware version will not always equal the protocol version going forward.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Query using the REPORT_FIRMWARE message.</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define FIRMATA_FIRMWARE_MAJOR_VERSION firmata::FIRMWARE_MAJOR_VERSION</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define FIRMATA_FIRMWARE_MINOR_VERSION firmata::FIRMWARE_MINOR_VERSION</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define FIRMATA_FIRMWARE_BUGFIX_VERSION firmata::FIRMWARE_BUGFIX_VERSION</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* Version numbers for the protocol. The protocol is still changing, so these</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * version numbers are important.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Query using the REPORT_VERSION message.</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define FIRMATA_PROTOCOL_MAJOR_VERSION firmata::PROTOCOL_MAJOR_VERSION // for non-compatible changes</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define FIRMATA_PROTOCOL_MINOR_VERSION firmata::PROTOCOL_MINOR_VERSION // for backwards compatible changes</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define FIRMATA_PROTOCOL_BUGFIX_VERSION firmata::PROTOCOL_BUGFIX_VERSION // for bugfix releases</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifdef MAX_DATA_BYTES</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#undef MAX_DATA_BYTES</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define MAX_DATA_BYTES firmata::MAX_DATA_BYTES // max number of data bytes in incoming messages</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// message command bytes (128-255/0x80-0xFF)</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifdef DIGITAL_MESSAGE</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#undef DIGITAL_MESSAGE</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define DIGITAL_MESSAGE firmata::DIGITAL_MESSAGE // send data for a digital port (collection of 8 pins)</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#ifdef ANALOG_MESSAGE</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#undef ANALOG_MESSAGE</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define ANALOG_MESSAGE firmata::ANALOG_MESSAGE // send data for an analog pin (or PWM)</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#ifdef REPORT_ANALOG</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#undef REPORT_ANALOG</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define REPORT_ANALOG firmata::REPORT_ANALOG // enable analog input by pin #</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#ifdef REPORT_DIGITAL</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#undef REPORT_DIGITAL</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#define REPORT_DIGITAL firmata::REPORT_DIGITAL // enable digital input by port pair</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#ifdef SET_PIN_MODE</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#undef SET_PIN_MODE</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#define SET_PIN_MODE firmata::SET_PIN_MODE // set a pin to INPUT/OUTPUT/PWM/etc</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#ifdef SET_DIGITAL_PIN_VALUE</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#undef SET_DIGITAL_PIN_VALUE</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#define SET_DIGITAL_PIN_VALUE firmata::SET_DIGITAL_PIN_VALUE // set value of an individual digital pin</span></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="comment">//</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#ifdef REPORT_VERSION</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#undef REPORT_VERSION</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#define REPORT_VERSION firmata::REPORT_VERSION // report protocol version</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#ifdef SYSTEM_RESET</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#undef SYSTEM_RESET</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#define SYSTEM_RESET firmata::SYSTEM_RESET // reset from MIDI</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#ifdef START_SYSEX</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#undef START_SYSEX</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#define START_SYSEX firmata::START_SYSEX // start a MIDI Sysex message</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#ifdef END_SYSEX</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#undef END_SYSEX</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#define END_SYSEX firmata::END_SYSEX // end a MIDI Sysex message</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// extended command set using sysex (0-127/0x00-0x7F)</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">/* 0x00-0x0F reserved for user-defined commands */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#ifdef SERIAL_MESSAGE</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#undef SERIAL_MESSAGE</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#define SERIAL_MESSAGE firmata::SERIAL_DATA // communicate with serial devices, including other boards</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#ifdef ENCODER_DATA</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#undef ENCODER_DATA</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#define ENCODER_DATA firmata::ENCODER_DATA // reply with encoders current positions</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#ifdef SERVO_CONFIG</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#undef SERVO_CONFIG</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#define SERVO_CONFIG firmata::SERVO_CONFIG // set max angle, minPulse, maxPulse, freq</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#ifdef STRING_DATA</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#undef STRING_DATA</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#define STRING_DATA firmata::STRING_DATA // a string message with 14-bits per char</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#ifdef STEPPER_DATA</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#undef STEPPER_DATA</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#define STEPPER_DATA firmata::STEPPER_DATA // control a stepper motor</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#ifdef ONEWIRE_DATA</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#undef ONEWIRE_DATA</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#define ONEWIRE_DATA firmata::ONEWIRE_DATA // send an OneWire read/write/reset/select/skip/search request</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#ifdef SHIFT_DATA</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#undef SHIFT_DATA</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#define SHIFT_DATA firmata::SHIFT_DATA // a bitstream to/from a shift register</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#ifdef I2C_REQUEST</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#undef I2C_REQUEST</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#define I2C_REQUEST firmata::I2C_REQUEST // send an I2C read/write request</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#ifdef I2C_REPLY</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#undef I2C_REPLY</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#define I2C_REPLY firmata::I2C_REPLY // a reply to an I2C read request</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#ifdef I2C_CONFIG</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#undef I2C_CONFIG</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#define I2C_CONFIG firmata::I2C_CONFIG // config I2C settings such as delay times and power pins</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#ifdef REPORT_FIRMWARE</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#undef REPORT_FIRMWARE</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#define REPORT_FIRMWARE firmata::REPORT_FIRMWARE // report name and version of the firmware</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#ifdef EXTENDED_ANALOG</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#undef EXTENDED_ANALOG</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#define EXTENDED_ANALOG firmata::EXTENDED_ANALOG // analog write (PWM, Servo, etc) to any pin</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#ifdef PIN_STATE_QUERY</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#undef PIN_STATE_QUERY</span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#define PIN_STATE_QUERY firmata::PIN_STATE_QUERY // ask for a pin's current mode and value</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#ifdef PIN_STATE_RESPONSE</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#undef PIN_STATE_RESPONSE</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#define PIN_STATE_RESPONSE firmata::PIN_STATE_RESPONSE // reply with pin's current mode and value</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#ifdef CAPABILITY_QUERY</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#undef CAPABILITY_QUERY</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#define CAPABILITY_QUERY firmata::CAPABILITY_QUERY // ask for supported modes and resolution of all pins</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor">#ifdef CAPABILITY_RESPONSE</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor">#undef CAPABILITY_RESPONSE</span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor">#define CAPABILITY_RESPONSE firmata::CAPABILITY_RESPONSE // reply with supported modes and resolution</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  </div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="preprocessor">#ifdef ANALOG_MAPPING_QUERY</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="preprocessor">#undef ANALOG_MAPPING_QUERY</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor">#define ANALOG_MAPPING_QUERY firmata::ANALOG_MAPPING_QUERY // ask for mapping of analog to pin numbers</span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  </div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="preprocessor">#ifdef ANALOG_MAPPING_RESPONSE</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#undef ANALOG_MAPPING_RESPONSE</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#define ANALOG_MAPPING_RESPONSE firmata::ANALOG_MAPPING_RESPONSE // reply with mapping info</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#ifdef SAMPLING_INTERVAL</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#undef SAMPLING_INTERVAL</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor">#define SAMPLING_INTERVAL firmata::SAMPLING_INTERVAL // set the poll rate of the main loop</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor">#ifdef SCHEDULER_DATA</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="preprocessor">#undef SCHEDULER_DATA</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#define SCHEDULER_DATA firmata::SCHEDULER_DATA // send a createtask/deletetask/addtotask/schedule/querytasks/querytask request to the scheduler</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="preprocessor">#ifdef SYSEX_NON_REALTIME</span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor">#undef SYSEX_NON_REALTIME</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#define SYSEX_NON_REALTIME firmata::SYSEX_NON_REALTIME // MIDI Reserved for non-realtime messages</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor">#ifdef SYSEX_REALTIME</span></div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="preprocessor">#undef SYSEX_REALTIME</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="preprocessor">#define SYSEX_REALTIME firmata::SYSEX_REALTIME // MIDI Reserved for realtime messages</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  </div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment">// pin modes</span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  </div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="preprocessor">#ifdef PIN_MODE_INPUT</span></div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor">#undef PIN_MODE_INPUT</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#define PIN_MODE_INPUT firmata::PIN_MODE_INPUT // same as INPUT defined in Arduino.h</span></div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor">#ifdef PIN_MODE_OUTPUT</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#undef PIN_MODE_OUTPUT</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor">#define PIN_MODE_OUTPUT firmata::PIN_MODE_OUTPUT // same as OUTPUT defined in Arduino.h</span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#ifdef PIN_MODE_ANALOG</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="preprocessor">#undef PIN_MODE_ANALOG</span></div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor">#define PIN_MODE_ANALOG firmata::PIN_MODE_ANALOG // analog pin in analogInput mode</span></div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  </div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="preprocessor">#ifdef PIN_MODE_PWM</span></div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor">#undef PIN_MODE_PWM</span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor">#define PIN_MODE_PWM firmata::PIN_MODE_PWM // digital pin in PWM output mode</span></div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  </div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="preprocessor">#ifdef PIN_MODE_SERVO</span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#undef PIN_MODE_SERVO</span></div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor">#define PIN_MODE_SERVO firmata::PIN_MODE_SERVO // digital pin in Servo output mode</span></div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="preprocessor">#ifdef PIN_MODE_SHIFT</span></div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#undef PIN_MODE_SHIFT</span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#define PIN_MODE_SHIFT firmata::PIN_MODE_SHIFT // shiftIn/shiftOut mode</span></div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#ifdef PIN_MODE_I2C</span></div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor">#undef PIN_MODE_I2C</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="preprocessor">#define PIN_MODE_I2C firmata::PIN_MODE_I2C // pin included in I2C setup</span></div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  </div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="preprocessor">#ifdef PIN_MODE_ONEWIRE</span></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor">#undef PIN_MODE_ONEWIRE</span></div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor">#define PIN_MODE_ONEWIRE firmata::PIN_MODE_ONEWIRE // pin configured for 1-wire</span></div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  </div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="preprocessor">#ifdef PIN_MODE_STEPPER</span></div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#undef PIN_MODE_STEPPER</span></div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#define PIN_MODE_STEPPER firmata::PIN_MODE_STEPPER // pin configured for stepper motor</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  </div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="preprocessor">#ifdef PIN_MODE_ENCODER</span></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor">#undef PIN_MODE_ENCODER</span></div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor">#define PIN_MODE_ENCODER firmata::PIN_MODE_ENCODER // pin configured for rotary encoders</span></div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  </div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="preprocessor">#ifdef PIN_MODE_SERIAL</span></div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="preprocessor">#undef PIN_MODE_SERIAL</span></div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="preprocessor">#define PIN_MODE_SERIAL firmata::PIN_MODE_SERIAL // pin configured for serial communication</span></div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="preprocessor">#ifdef PIN_MODE_PULLUP</span></div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="preprocessor">#undef PIN_MODE_PULLUP</span></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="preprocessor">#define PIN_MODE_PULLUP firmata::PIN_MODE_PULLUP // enable internal pull-up resistor for pin</span></div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  </div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor">#ifdef PIN_MODE_IGNORE</span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="preprocessor">#undef PIN_MODE_IGNORE</span></div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="preprocessor">#define PIN_MODE_IGNORE firmata::PIN_MODE_IGNORE // pin configured to be ignored by digitalWrite and capabilityResponse</span></div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  </div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="preprocessor">#ifdef TOTAL_PIN_MODES</span></div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="preprocessor">#undef TOTAL_PIN_MODES</span></div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="preprocessor">#define TOTAL_PIN_MODES firmata::TOTAL_PIN_MODES</span></div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  </div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="preprocessor">#endif // FirmataConstants_h</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|