/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
namespace Tizen.Sensor
{
///
/// The Magnetometer class is used for registering callbacks for the magnetometer and getting the magnetometer data.
///
/// 3
public sealed class Magnetometer : Sensor
{
private static string MagnetometerKey = "http://tizen.org/feature/sensor.magnetometer";
private event EventHandler _accuracyChanged;
///
/// Gets the X component of the magnetometer.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
/// Gets the Y component of the magnetometer.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
/// Gets the Z component of the magnetometer.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
/// Returns true or false based on whether magnetometer is supported by the device.
///
/// 3
/// true if supported; otherwise false.
public static bool IsSupported
{
get
{
Log.Info(Globals.LogTag, "Checking if the Magnetometer is supported");
return CheckIfSupported(SensorType.Magnetometer, MagnetometerKey);
}
}
///
/// Returns the number of magnetometers available on the device.
///
/// 3
/// The count of magnetometers.
public static int Count
{
get
{
Log.Info(Globals.LogTag, "Getting the count of magnetometers");
return GetCount();
}
}
///
/// Initializes a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.magnetometer
/// Thrown when an invalid argument is used.
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
/// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors.
///
public Magnetometer(uint index = 0) : base(index)
{
Log.Info(Globals.LogTag, "Creating Magnetometer object");
}
internal override SensorType GetSensorType()
{
return SensorType.Magnetometer;
}
///
/// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data.
///
/// 3
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
///
/// 3
public event EventHandler AccuracyChanged
{
add
{
if (_accuracyChanged == null)
{
AccuracyListenStart();
}
_accuracyChanged += value;
}
remove
{
_accuracyChanged -= value;
if (_accuracyChanged == null)
{
AccuracyListenStop();
}
}
}
private static int GetCount()
{
IntPtr list;
int count;
int error = Interop.SensorManager.GetSensorList(SensorType.Magnetometer, out list, out count);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error getting sensor list for magnetometer");
count = 0;
}
else
Interop.Libc.Free(list);
return count;
}
///
/// Read magnetometer data synchronously.
///
internal override void ReadData()
{
Interop.SensorEventStruct sensorData;
int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error reading magnetometer data");
throw SensorErrorFactory.CheckAndThrowException(error, "Reading magnetometer data failed");
}
Timestamp = sensorData.timestamp;
X = sensorData.values[0];
Y = sensorData.values[1];
Z = sensorData.values[2];
}
private static Interop.SensorListener.SensorEventsCallback _callback;
internal override void EventListenStart()
{
_callback = (IntPtr sensorHandle, IntPtr eventPtr, uint events_count, IntPtr data) => {
updateBatchEvents(eventPtr, events_count);
Interop.SensorEventStruct sensorData = latestEvent();
Timestamp = sensorData.timestamp;
X = sensorData.values[0];
Y = sensorData.values[1];
Z = sensorData.values[2];
DataUpdated?.Invoke(this, new MagnetometerDataUpdatedEventArgs(sensorData.values));
};
int error = Interop.SensorListener.SetEventsCallback(ListenerHandle, _callback, IntPtr.Zero);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error setting event callback for magnetometer");
throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for magnetometer");
}
}
internal override void EventListenStop()
{
int error = Interop.SensorListener.UnsetEventsCallback(ListenerHandle);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error unsetting event callback for magnetometer");
throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for magnetometer");
}
}
private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
private void AccuracyListenStart()
{
_accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
Timestamp = timestamp;
_accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(timestamp, accuracy));
};
int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error setting accuracy event callback for magnetometer");
throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for magnetometer");
}
}
private void AccuracyListenStop()
{
int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
if (error != (int)SensorError.None)
{
Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for magnetometer");
throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for magnetometer");
}
}
}
}