dnutiu/NucuCar
dnutiu/NucuCar
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename GetTelemetryData to GetTelemetryJson in ITelemeter

Browse source
This commit is contained in:
Denis-Cosmin Nutiu 2021-10-03 18:08:07 +03:00
parent 5f86a37724
commit b52f292db1
7 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
NucuCar.Sensors/Abstractions/GenericTelemeterSensor.cs
View file

@ -13,7 +13,7 @@ namespace NucuCar.Sensors.Abstractions
{ {
protected bool TelemetryEnabled; protected bool TelemetryEnabled;
public abstract string GetIdentifier(); public abstract string GetIdentifier();
public abstract Dictionary<string, object> GetTelemetryData(); public abstract Dictionary<string, object> GetTelemetryJson();
public abstract bool IsTelemetryEnabled(); public abstract bool IsTelemetryEnabled();
} }
} }

2
NucuCar.Sensors/Modules/BME680/Bme680Sensor.cs
View file

@ -153,7 +153,7 @@ namespace NucuCar.Sensors.Modules.BME680
return "Environment"; return "Environment";
} }
public override Dictionary<string, object> GetTelemetryData() public override Dictionary<string, object> GetTelemetryJson()
{ {
Dictionary<string, object> returnValue = null; Dictionary<string, object> returnValue = null;
if (_lastMeasurement != null && TelemetryEnabled) if (_lastMeasurement != null && TelemetryEnabled)

2
NucuCar.Sensors/Modules/CpuTemperature/CpuTempSensor.cs
View file

@ -84,7 +84,7 @@ namespace NucuCar.Sensors.Modules.CpuTemperature
return "CpuTemperature"; return "CpuTemperature";
} }
public override Dictionary<string, object> GetTelemetryData() public override Dictionary<string, object> GetTelemetryJson()
{ {
Dictionary<string, object> returnValue = null; Dictionary<string, object> returnValue = null;
if (!double.IsNaN(_lastTemperatureCelsius) && TelemetryEnabled) if (!double.IsNaN(_lastTemperatureCelsius) && TelemetryEnabled)

2
NucuCar.Sensors/Modules/Heartbeat/HeartbeatSensor.cs
View file

@ -59,7 +59,7 @@ namespace NucuCar.Sensors.Modules.Heartbeat
return "Heartbeat"; return "Heartbeat";
} }
public override Dictionary<string, object> GetTelemetryData() public override Dictionary<string, object> GetTelemetryJson()
{ {
var returnValue = new Dictionary<string, object> var returnValue = new Dictionary<string, object>
{ {

2
NucuCar.Sensors/Modules/PMS5003/Pms5003Sensor.cs
View file

@ -124,7 +124,7 @@ namespace NucuCar.Sensors.Modules.PMS5003
return "Pms5003"; return "Pms5003";
} }
public override Dictionary<string, object> GetTelemetryData() public override Dictionary<string, object> GetTelemetryJson()
{ {
Dictionary<string, object> returnValue = null; Dictionary<string, object> returnValue = null;
if (_pms5003Data != null && TelemetryEnabled) if (_pms5003Data != null && TelemetryEnabled)

4
NucuCar.Telemetry/Abstractions/ITelemeter.cs
View file

@ -14,14 +14,14 @@ namespace NucuCar.Telemetry.Abstractions
/// <returns>An identifier for the telemetry source.</returns> /// <returns>An identifier for the telemetry source.</returns>
string GetIdentifier(); string GetIdentifier();
// TODO: Perhaps here it's better if we return a string. // TODO: Perhaps here it's better if we return a string or a json object from Newtonsoft.
/// <summary> /// <summary>
/// This function should return a dictionary containing the telemetry data. /// This function should return a dictionary containing the telemetry data.
/// When implementing this function you should return null if the telemetry is disabled. /// When implementing this function you should return null if the telemetry is disabled.
/// See: <see cref="IsTelemetryEnabled"/> /// See: <see cref="IsTelemetryEnabled"/>
/// </summary> /// </summary>
/// <returns>The telemetry data. It should be JSON serializable.</returns> /// <returns>The telemetry data. It should be JSON serializable.</returns>
Dictionary<string, object> GetTelemetryData(); Dictionary<string, object> GetTelemetryJson();
/// <summary> /// <summary>
/// This function should return whether the sensor has telemetry enabled or not. /// This function should return whether the sensor has telemetry enabled or not.

2
NucuCar.Telemetry/Abstractions/TelemetryPublisher.cs
View file

@ -103,7 +103,7 @@ namespace NucuCar.Telemetry.Abstractions
var data = new List<Dictionary<string, object>>(); var data = new List<Dictionary<string, object>>();
foreach (var telemeter in RegisteredTelemeters) foreach (var telemeter in RegisteredTelemeters)
{ {
var telemetryData = telemeter.GetTelemetryData(); var telemetryData = telemeter.GetTelemetryJson();
if (telemetryData == null) if (telemetryData == null)
{ {
Logger?.LogWarning("Warning! Data for {Identifier} is null!", telemeter.GetIdentifier()); Logger?.LogWarning("Warning! Data for {Identifier} is null!", telemeter.GetIdentifier());