File: //usr/share/gtk-doc/html/iio-sensor-proxy/gdbus-net.hadess.SensorProxy.Compass.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>net.hadess.SensorProxy.Compass: Sensor Proxy Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Sensor Proxy Reference Manual">
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
<link rel="prev" href="gdbus-net.hadess.SensorProxy.html" title="net.hadess.SensorProxy">
<link rel="next" href="ix01.html" title="Index">
<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gdbus-net.hadess.SensorProxy.Compass.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-net.hadess.SensorProxy.Compass.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-net.hadess.SensorProxy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-net.hadess.SensorProxy.Compass"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-net-hadess-SensorProxy-Compass.top_of_page"></a>net.hadess.SensorProxy.Compass</span></h2>
<p>net.hadess.SensorProxy.Compass — D-Bus proxy to access Compass sensors</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-net.hadess.SensorProxy.Compass.html#gdbus-method-net-hadess-SensorProxy-Compass.ClaimCompass" title="The ClaimCompass() method">ClaimCompass</a> ();
<a class="link" href="gdbus-net.hadess.SensorProxy.Compass.html#gdbus-method-net-hadess-SensorProxy-Compass.ReleaseCompass" title="The ReleaseCompass() method">ReleaseCompass</a> ();
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.4.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-net.hadess.SensorProxy.Compass.html#gdbus-property-net-hadess-SensorProxy-Compass.HasCompass" title='The "HasCompass" property'>HasCompass</a> readable b
<a class="link" href="gdbus-net.hadess.SensorProxy.Compass.html#gdbus-property-net-hadess-SensorProxy-Compass.CompassHeading" title='The "CompassHeading" property'>CompassHeading</a> readable d
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-net-hadess-SensorProxy-Compass"></a><h2>Description</h2>
<p> After checking the availability of the sensor type you want to monitor,
call the net.hadess.SensorProxy.ClaimCompass() method to start updating
the properties from the hardware readings.
</p>
<p> The object path will be "/net/hadess/SensorProxy/Compass".
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-net.hadess.SensorProxy.Compass"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-net-hadess-SensorProxy-Compass.ClaimCompass"></a><h3>The ClaimCompass() method</h3>
<pre class="programlisting">
ClaimCompass ();
</pre>
<p> To start receiving compass heading updates from the proxy, the
application must call the net.hadess.SensorProxy.ClaimCompass() method. It can do so
whether a compass is available or not, updates would then be sent
when such a sensor appears.
</p>
<p> Applications should call net.hadess.SensorProxy.ReleaseCompass() when readings are
not required anymore. This prevents the sensor proxy from polling the device, thus
increasing wake-ups and reducing battery life.
</p>
<p> Note that Compass information is only available to Geoclue by default, which will
proxy the magnetic heading information, and transform it to True North heading.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-net-hadess-SensorProxy-Compass.ReleaseCompass"></a><h3>The ReleaseCompass() method</h3>
<pre class="programlisting">
ReleaseCompass ();
</pre>
<p> This should be called as soon as readings are not required anymore. Note
that resources are freed up if a monitoring application exits without
calling net.hadess.SensorProxy.ReleaseCompass(), crashes or the sensor disappears.
</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-net.hadess.SensorProxy.Compass"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-net-hadess-SensorProxy-Compass.HasCompass"></a><h3>The "HasCompass" property</h3>
<pre class="programlisting">
HasCompass readable b
</pre>
<p> Whether a supported compass is present on the system.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-net-hadess-SensorProxy-Compass.CompassHeading"></a><h3>The "CompassHeading" property</h3>
<pre class="programlisting">
CompassHeading readable d
</pre>
<p> The compass heading in degrees with respect to magnetic North direction, in
clockwise order. That means North becomes 0 degree, East: 90 degrees,
South: 180 degrees, West: 270 degrees and so on. When unknown,
it's set to -1.0.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29.1</div>
</body>
</html>