communication_langage_protocol.html
17.1 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Communication protocols for astromecca mounts — Mount Control Software 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script 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="User guide to program with mount Python classes" href="using_mount_classes.html" />
<link rel="prev" title="First steps with the Mount Control Software" href="using_mount_control_software.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="using_mount_classes.html" title="User guide to program with mount Python classes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="using_mount_control_software.html" title="First steps with the Mount Control Software"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Mount Control Software 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Communication protocols for astromecca mounts</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="communication-protocols-for-astromecca-mounts">
<h1>Communication protocols for astromecca mounts<a class="headerlink" href="#communication-protocols-for-astromecca-mounts" title="Permalink to this headline">¶</a></h1>
<p>This section describes how to use a client software to communicate with
a running astromecca server.</p>
<p>Available protocol transports are:</p>
<blockquote>
<div><ul class="simple">
<li><p>Serial RS232.</p></li>
<li><p>Ethernet TCP.</p></li>
</ul>
</div></blockquote>
<p>Available protocol langages are:</p>
<blockquote>
<div><ul class="simple">
<li><p>LX200. The classical Meade LX200 syntax.</p></li>
<li><p>ASCOM. ASCOM driver for Astromecca mounts</p></li>
<li><p>MCS. Json based messages to allow any operation with the mount.</p></li>
</ul>
</div></blockquote>
<p>The default configuration of the MCS script is to run using ASCOM protocol
via serial port RS232 (driver astromecca, 115200 bauds).</p>
<p>It is possible to mix any protocol transport with any protocol langage.
However, do not forget that LX200 langage protocol is usually used
with a RS232 serial transport at 9600 bauds.</p>
<div class="section" id="serial-port-and-lx200-protocol">
<h2>1. Serial port and LX200 protocol<a class="headerlink" href="#serial-port-and-lx200-protocol" title="Permalink to this headline">¶</a></h2>
<p>The client must connect a serial wire between its computer and the astromecca computer.
For example, you can use an ASCOM or INDI client to communicate with the astromecca server.
You have configure ASCOM or INDI to the protocol langage LX200 and the serial transport protocol as 9600 bauds.</p>
<p>If you want to write a Python code to create client, you can use the class MountremoteClient
which wraps the serial protocol. When the MountremoteClient is instanciated the method
putread_chan send the command and receive the response.
The following example gets the declination of the mount via the LX200 command :GD:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mountremote</span> <span class="k">import</span> <span class="n">MountremoteClient</span>
<span class="n">remote_client</span> <span class="o">=</span> <span class="n">MountremoteClient</span><span class="p">(</span><span class="s2">"SERIAL"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s2">"COM1"</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="s2">"LX200"</span><span class="p">,</span> <span class="n">baud</span><span class="o">=</span><span class="mi">9600</span><span class="p">)</span>
<span class="n">command</span> <span class="o">=</span> <span class="s1">':GD#'</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">remote_client</span><span class="o">.</span><span class="n">putread_chan</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Command = </span><span class="si">{}</span><span class="se">\n</span><span class="s2">Result = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">command</span><span class="p">,</span><span class="n">result</span><span class="p">))</span>
<span class="k">del</span><span class="p">(</span><span class="n">remote_client</span><span class="p">)</span>
</pre></div>
</div>
<p>The implemented LX200 commands described in <a class="reference external" href="https://www.meade.com/support/LX200CommandSet.pdf">https://www.meade.com/support/LX200CommandSet.pdf</a> are:
:CM, :Gc, :GC, :GD, :Gg, :GL, :Gm, :GR, :Gt, :H, :Me, :Mn, :Ms, :Mw, :MS, :P,
:Qe, :Qn, :Qs, :Qw, :Q, :RC, :RG, :RM, :RS, :Sr, :Sd, :Sg, :Sts, :U.</p>
</div>
<div class="section" id="ethernet-tcp-port-and-mcs-protocol">
<h2>2. Ethernet TCP port and MCS protocol<a class="headerlink" href="#ethernet-tcp-port-and-mcs-protocol" title="Permalink to this headline">¶</a></h2>
<p>The client must connect an Ethernet wire or establish a wifi connection between its computer and the astromecca computer.
Configure the TCP transport protocol to send messages on the port 1111.</p>
<p>The following example gets the right ascension, the declination and the peer side of the mount via the astromecca command get radec.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mountremote</span> <span class="k">import</span> <span class="n">MountremoteClient</span>
<span class="n">remote_client</span> <span class="o">=</span> <span class="n">MountremoteClient</span><span class="p">(</span><span class="s2">"TCP"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">1111</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="s2">"MCS"</span><span class="p">)</span>
<span class="n">command</span> <span class="o">=</span> <span class="s2">"{'req': {'get': 'radec'}}"</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">remote_client</span><span class="o">.</span><span class="n">putread_chan</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Command = </span><span class="si">{}</span><span class="se">\n</span><span class="s2">Result = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">command</span><span class="p">,</span><span class="n">result</span><span class="p">))</span>
<span class="k">del</span><span class="p">(</span><span class="n">remote_client</span><span class="p">)</span>
</pre></div>
</div>
<p>The most useful command is ‘exec’ which allow to execute
any python command of the mount thread. By this way it is possible
to drive the mount with only this command. The following example show
how to call directly the method which returns the radec coordinates:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mountremote</span> <span class="k">import</span> <span class="n">MountremoteClient</span>
<span class="n">remote_client</span> <span class="o">=</span> <span class="n">MountremoteClient</span><span class="p">(</span><span class="s2">"TCP"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">1111</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="s2">"MCS"</span><span class="p">)</span>
<span class="n">command</span> <span class="o">=</span> <span class="s2">"{'req': {'do': {'exec' , 'self.radec_coord()'}}}"</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">remote_client</span><span class="o">.</span><span class="n">putread_chan</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Command = </span><span class="si">{}</span><span class="se">\n</span><span class="s2">Result = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">command</span><span class="p">,</span><span class="n">result</span><span class="p">))</span>
<span class="k">del</span><span class="p">(</span><span class="n">remote_client</span><span class="p">)</span>
</pre></div>
</div>
<p>You can execute a GOTO action:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mountremote</span> <span class="k">import</span> <span class="n">MountremoteClient</span>
<span class="n">remote_client</span> <span class="o">=</span> <span class="n">MountremoteClient</span><span class="p">(</span><span class="s2">"TCP"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">1111</span><span class="p">,</span> <span class="n">protocol</span><span class="o">=</span><span class="s2">"MCS"</span><span class="p">)</span>
<span class="n">command</span> <span class="o">=</span> <span class="s2">"{'req': {'do': {'exec' , 'self.radec_goto("</span><span class="mi">4</span><span class="n">h45m</span><span class="p">,</span><span class="s2">"+05d18m"</span><span class="p">)</span><span class="s1">'}}}"</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">remote_client</span><span class="o">.</span><span class="n">putread_chan</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">"Command = </span><span class="si">{}</span><span class="se">\n</span><span class="s2">Result = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">command</span><span class="p">,</span><span class="n">result</span><span class="p">))</span>
<span class="k">del</span><span class="p">(</span><span class="n">remote_client</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="the-mcs-langage-protocol">
<h2>3. The MCS langage protocol<a class="headerlink" href="#the-mcs-langage-protocol" title="Permalink to this headline">¶</a></h2>
<p>The messages are Json formated. Basically the hierarchy is defined as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">command</span> <span class="o">=</span> <span class="s2">"{typemsg: {action: {cmd: val}}}"</span>
</pre></div>
</div>
<p>The following combinations can be used:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 23%" />
<col style="width: 23%" />
<col style="width: 21%" />
<col style="width: 34%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>typemsg</p></th>
<th class="head"><p>action</p></th>
<th class="head"><p>cmd</p></th>
<th class="head"><p>val</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>req</p></td>
<td><p>do</p></td>
<td><p>exec</p></td>
<td><p><em>Python command</em></p></td>
</tr>
<tr class="row-odd"><td><p>req</p></td>
<td><p>get</p></td>
<td><p>radec</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>req</p></td>
<td><p>get</p></td>
<td><p>hadec</p></td>
<td></td>
</tr>
</tbody>
</table>
<p>The reponse is also a Json structure for which the keys reflect
those of the request (but ‘req’ is replaced by ‘res’):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Command</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'req'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'radec'</span><span class="p">}}</span>
<span class="n">Result</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'res'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'get'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'radec'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'ra'</span><span class="p">:</span> <span class="mf">93.77897552123532</span><span class="p">,</span> <span class="s1">'dec'</span><span class="p">:</span> <span class="mf">0.007976942637754572</span><span class="p">,</span> <span class="s1">'side'</span><span class="p">:</span> <span class="mi">1</span><span class="p">}]}}}</span>
</pre></div>
</div>
<p>Note the val is a list or any other kind of type in case of (req,de,exec).</p>
</div>
</div>
<div class="clearer"></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="#">Communication protocols for astromecca mounts</a><ul>
<li><a class="reference internal" href="#serial-port-and-lx200-protocol">1. Serial port and LX200 protocol</a></li>
<li><a class="reference internal" href="#ethernet-tcp-port-and-mcs-protocol">2. Ethernet TCP port and MCS protocol</a></li>
<li><a class="reference internal" href="#the-mcs-langage-protocol">3. The MCS langage protocol</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="using_mount_control_software.html"
title="previous chapter">First steps with the Mount Control Software</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="using_mount_classes.html"
title="next chapter">User guide to program with mount Python classes</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/communication_langage_protocol.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="using_mount_classes.html" title="User guide to program with mount Python classes"
>next</a> |</li>
<li class="right" >
<a href="using_mount_control_software.html" title="First steps with the Mount Control Software"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Mount Control Software 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Communication protocols for astromecca mounts</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2021, astromecca.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.0.
</div>
</body>
</html>