pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-14 12:15:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add async method for devjson

Browse Source
This commit is contained in:
Andrew Welker
2024-07-18 13:44:49 -05:00
parent b63996b9e6
commit fb60683af6
1 changed files with 340 additions and 276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

616
src/PepperDash.Essentials.Core/Devices/DeviceJsonApi.cs
View File

@@ -1,83 +1,81 @@
using Crestron.SimplSharp;
using Newtonsoft.Json;
using PepperDash.Core;
using Serilog.Events;
using System; using System;
using System.Collections; using System.Collections;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Crestron.SimplSharp;
using System.Reflection; using System.Reflection;
using Newtonsoft.Json; using System.Threading.Tasks;
using PepperDash.Core;
using Serilog.Events;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
public class DeviceJsonApi public class DeviceJsonApi
{ {
/// <summary> /// <summary>
/// ///
/// </summary> /// </summary>
/// <param name="json"></param> /// <param name="json"></param>
public static void DoDeviceActionWithJson(string json) public static void DoDeviceActionWithJson(string json)
{ {
if (String.IsNullOrEmpty(json)) if (String.IsNullOrEmpty(json))
{ {
CrestronConsole.ConsoleCommandResponse( CrestronConsole.ConsoleCommandResponse(
"Please provide a JSON object matching the format {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}.\r\nIf the method has no parameters, the \"params\" object may be omitted."); "Please provide a JSON object matching the format {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}.\r\nIf the method has no parameters, the \"params\" object may be omitted.");
return; return;
} }
try try
{ {
var action = JsonConvert.DeserializeObject<DeviceActionWrapper>(json); var action = JsonConvert.DeserializeObject<DeviceActionWrapper>(json);
DoDeviceAction(action); DoDeviceAction(action);
} }
catch (Exception ex) catch (Exception)
{ {
CrestronConsole.ConsoleCommandResponse("Incorrect format for JSON. Please check that the format matches {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}"); CrestronConsole.ConsoleCommandResponse("Incorrect format for JSON. Please check that the format matches {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}");
} }
} }
/// <summary> /// <summary>
/// ///
/// </summary> /// </summary>
/// <param name="action"></param> /// <param name="action"></param>
public static void DoDeviceAction(DeviceActionWrapper action) public static void DoDeviceAction(DeviceActionWrapper action)
{ {
var key = action.DeviceKey; var key = action.DeviceKey;
var obj = FindObjectOnPath(key); var obj = FindObjectOnPath(key);
if (obj == null) if (obj == null)
{ {
CrestronConsole.ConsoleCommandResponse("Unable to find object at path {0}", key); CrestronConsole.ConsoleCommandResponse("Unable to find object at path {0}", key);
return; return;
} }
if (action.Params == null) if (action.Params == null)
{ {
//no params, so setting action.Params to empty array //no params, so setting action.Params to empty array
action.Params = new object[0]; action.Params = new object[0];
} }
Type t = obj.GetType(); Type t = obj.GetType();
try try
{ {
var methods = t.GetMethods().Where(m => m.Name == action.MethodName).ToList(); var methods = t.GetMethods().Where(m => m.Name == action.MethodName).ToList();
var method = methods.Count == 1 ? methods[0] : methods.FirstOrDefault(m => m.GetParameters().Length == action.Params.Length); var method = methods.Count == 1 ? methods[0] : methods.FirstOrDefault(m => m.GetParameters().Length == action.Params.Length);
if (method == null) if (method == null)
{ {
CrestronConsole.ConsoleCommandResponse( CrestronConsole.ConsoleCommandResponse(
"Unable to find method with name {0} and that matches parameters {1}", action.MethodName, "Unable to find method with name {0} and that matches parameters {1}", action.MethodName,
action.Params); action.Params);
return; return;
} }
var mParams = method.GetParameters(); var mParams = method.GetParameters();
var convertedParams = mParams var convertedParams = mParams
@@ -85,60 +83,119 @@ namespace PepperDash.Essentials.Core
.ToArray(); .ToArray();
Task.Run(() => Task.Run(() =>
{ {
try try
{ {
Debug.LogMessage(LogEventLevel.Verbose, "Calling method {methodName} on device {deviceKey}", null, method.Name, action.DeviceKey); Debug.LogMessage(LogEventLevel.Verbose, "Calling method {methodName} on device {deviceKey}", null, method.Name, action.DeviceKey);
method.Invoke(obj, convertedParams); method.Invoke(obj, convertedParams);
} }
catch(Exception e) catch (Exception e)
{ {
Debug.LogMessage(e, "Error invoking method {methodName} on device {deviceKey}", null, method.Name, action.DeviceKey); Debug.LogMessage(e, "Error invoking method {methodName} on device {deviceKey}", null, method.Name, action.DeviceKey);
} }
}); });
CrestronConsole.ConsoleCommandResponse("Method {0} successfully called on device {1}", method.Name, CrestronConsole.ConsoleCommandResponse("Method {0} successfully called on device {1}", method.Name,
action.DeviceKey); action.DeviceKey);
} }
catch (Exception ex) catch (Exception ex)
{ {
CrestronConsole.ConsoleCommandResponse("Unable to call method with name {0}. {1}", action.MethodName, CrestronConsole.ConsoleCommandResponse("Unable to call method with name {0}. {1}", action.MethodName,
ex.Message);} ex.Message);
} }
}
private static object ConvertType(object value, Type conversionType) public static async Task DoDeviceActionAsync(DeviceActionWrapper action)
{ {
if (!conversionType.IsEnum) var key = action.DeviceKey;
{ var obj = FindObjectOnPath(key);
return Convert.ChangeType(value, conversionType, System.Globalization.CultureInfo.InvariantCulture); if (obj == null)
} {
Debug.LogMessage(LogEventLevel.Warning, "Unable to find object at path {deviceKey}", null, key);
return;
}
var stringValue = Convert.ToString(value); if (action.Params == null)
{
//no params, so setting action.Params to empty array
action.Params = new object[0];
}
if (String.IsNullOrEmpty(stringValue)) Type t = obj.GetType();
{ try
throw new InvalidCastException( {
String.Format("{0} cannot be converted to a string prior to conversion to enum")); var methods = t.GetMethods().Where(m => m.Name == action.MethodName).ToList();
}
return Enum.Parse(conversionType, stringValue, true);
}
/// <summary> var method = methods.Count == 1 ? methods[0] : methods.FirstOrDefault(m => m.GetParameters().Length == action.Params.Length);
/// Gets the properties on a device
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public static string GetProperties(string deviceObjectPath)
{
var obj = FindObjectOnPath(deviceObjectPath);
if (obj == null)
return "{ \"error\":\"No Device\"}";
Type t = obj.GetType(); if (method == null)
// get the properties and set them into a new collection of NameType wrappers {
var props = t.GetProperties().Select(p => new PropertyNameType(p, obj)); Debug.LogMessage(LogEventLevel.Warning,
return JsonConvert.SerializeObject(props, Formatting.Indented); "Unable to find method with name {methodName} and that matches parameters {@parameters}", null, action.MethodName,
} action.Params);
return;
}
var mParams = method.GetParameters();
var convertedParams = mParams
.Select((p, i) => ConvertType(action.Params[i], p.ParameterType))
.ToArray();
await Task.Run(() =>
{
try
{
Debug.LogMessage(LogEventLevel.Verbose, "Calling method {methodName} on device {deviceKey} with {@params}", null, method.Name, action.DeviceKey, action.Params);
method.Invoke(obj, convertedParams);
}
catch (Exception e)
{
Debug.LogMessage(e, "Error invoking method {methodName} on device {deviceKey}", null, method.Name, action.DeviceKey);
}
});
Debug.LogMessage(LogEventLevel.Information, "Method {methodName} successfully called on device {deviceKey} with {@params}", null, method.Name,
action.DeviceKey, action.Params);
}
catch (Exception ex)
{
Debug.LogMessage(ex, "Unable to call method with name {methodName} with {@parameters}", null, action.MethodName, action.Params);
}
}
private static object ConvertType(object value, Type conversionType)
{
if (!conversionType.IsEnum)
{
return Convert.ChangeType(value, conversionType, System.Globalization.CultureInfo.InvariantCulture);
}
var stringValue = Convert.ToString(value);
if (String.IsNullOrEmpty(stringValue))
{
throw new InvalidCastException(
String.Format("{0} cannot be converted to a string prior to conversion to enum"));
}
return Enum.Parse(conversionType, stringValue, true);
}
/// <summary>
/// Gets the properties on a device
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public static string GetProperties(string deviceObjectPath)
{
var obj = FindObjectOnPath(deviceObjectPath);
if (obj == null)
return "{ \"error\":\"No Device\"}";
Type t = obj.GetType();
// get the properties and set them into a new collection of NameType wrappers
var props = t.GetProperties().Select(p => new PropertyNameType(p, obj));
return JsonConvert.SerializeObject(props, Formatting.Indented);
}
/// <summary> /// <summary>
/// Gets a property from a device path by name /// Gets a property from a device path by name
@@ -149,9 +206,9 @@ namespace PepperDash.Essentials.Core
public static object GetPropertyByName(string deviceObjectPath, string propertyName) public static object GetPropertyByName(string deviceObjectPath, string propertyName)
{ {
var dev = FindObjectOnPath(deviceObjectPath); var dev = FindObjectOnPath(deviceObjectPath);
if(dev == null) if (dev == null)
return "{ \"error\":\"No Device\"}"; return "{ \"error\":\"No Device\"}";
object prop = dev.GetType().GetType().GetProperty(propertyName).GetValue(dev, null); object prop = dev.GetType().GetType().GetProperty(propertyName).GetValue(dev, null);
// var prop = t.GetProperty(propertyName); // var prop = t.GetProperty(propertyName);
@@ -166,126 +223,126 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary> /// <summary>
/// Gets the methods on a device /// Gets the methods on a device
/// </summary> /// </summary>
/// <param name="key"></param> /// <param name="key"></param>
/// <returns></returns> /// <returns></returns>
public static string GetMethods(string deviceObjectPath) public static string GetMethods(string deviceObjectPath)
{ {
var obj = FindObjectOnPath(deviceObjectPath); var obj = FindObjectOnPath(deviceObjectPath);
if (obj == null) if (obj == null)
return "{ \"error\":\"No Device\"}"; return "{ \"error\":\"No Device\"}";
// Package up method names using helper objects // Package up method names using helper objects
Type t = obj.GetType(); Type t = obj.GetType();
var methods = t.GetMethods() var methods = t.GetMethods()
.Where(m => !m.IsSpecialName) .Where(m => !m.IsSpecialName)
.Select(p => new MethodNameParams(p)); .Select(p => new MethodNameParams(p));
return JsonConvert.SerializeObject(methods, Formatting.Indented); return JsonConvert.SerializeObject(methods, Formatting.Indented);
} }
public static string GetApiMethods(string deviceObjectPath) public static string GetApiMethods(string deviceObjectPath)
{ {
var obj = FindObjectOnPath(deviceObjectPath); var obj = FindObjectOnPath(deviceObjectPath);
if (obj == null) if (obj == null)
return "{ \"error\":\"No Device\"}"; return "{ \"error\":\"No Device\"}";
// Package up method names using helper objects // Package up method names using helper objects
Type t = obj.GetType(); Type t = obj.GetType();
var methods = t.GetMethods() var methods = t.GetMethods()
.Where(m => !m.IsSpecialName) .Where(m => !m.IsSpecialName)
.Where(m => m.GetCustomAttributes(typeof(ApiAttribute), true).Any()) .Where(m => m.GetCustomAttributes(typeof(ApiAttribute), true).Any())
.Select(p => new MethodNameParams(p)); .Select(p => new MethodNameParams(p));
return JsonConvert.SerializeObject(methods, Formatting.Indented); return JsonConvert.SerializeObject(methods, Formatting.Indented);
} }
/// <summary>
/// Walks down a dotted object path, starting with a Device, and returns the object
/// at the end of the path
/// </summary>
public static object FindObjectOnPath(string deviceObjectPath)
{
var path = deviceObjectPath.Split('.');
var dev = DeviceManager.GetDeviceForKey(path[0]); /// <summary>
if (dev == null) /// Walks down a dotted object path, starting with a Device, and returns the object
{ /// at the end of the path
Debug.LogMessage(LogEventLevel.Information, "Device {0} not found", path[0]); /// </summary>
return null; public static object FindObjectOnPath(string deviceObjectPath)
} {
var path = deviceObjectPath.Split('.');
// loop through any dotted properties var dev = DeviceManager.GetDeviceForKey(path[0]);
object obj = dev; if (dev == null)
if (path.Length > 1) {
{ Debug.LogMessage(LogEventLevel.Information, "Device {0} not found", path[0]);
for (int i = 1; i < path.Length; i++) return null;
{ }
var objName = path[i];
string indexStr = null;
var indexOpen = objName.IndexOf('[');
if (indexOpen != -1)
{
var indexClose = objName.IndexOf(']');
if (indexClose == -1)
{
Debug.LogMessage(LogEventLevel.Information, dev, "ERROR Unmatched index brackets");
return null;
}
// Get the index and strip quotes if any
indexStr = objName.Substring(indexOpen + 1, indexClose - indexOpen - 1).Replace("\"", "");
objName = objName.Substring(0, indexOpen);
Debug.LogMessage(LogEventLevel.Information, dev, " Checking for collection '{0}', index '{1}'", objName, indexStr);
}
Type oType = obj.GetType(); // loop through any dotted properties
var prop = oType.GetProperty(objName); object obj = dev;
if (prop == null) if (path.Length > 1)
{ {
Debug.LogMessage(LogEventLevel.Information, dev, "Property {0} not found on {1}", objName, path[i - 1]); for (int i = 1; i < path.Length; i++)
return null; {
} var objName = path[i];
// if there's an index, try to get the property string indexStr = null;
if (indexStr != null) var indexOpen = objName.IndexOf('[');
{ if (indexOpen != -1)
if (!typeof(ICollection).IsAssignableFrom(prop.PropertyType)) {
{ var indexClose = objName.IndexOf(']');
Debug.LogMessage(LogEventLevel.Information, dev, "Property {0} is not collection", objName); if (indexClose == -1)
return null; {
} Debug.LogMessage(LogEventLevel.Information, dev, "ERROR Unmatched index brackets");
var collection = prop.GetValue(obj, null) as ICollection; return null;
// Get the indexed items "property" }
var indexedPropInfo = prop.PropertyType.GetProperty("Item"); // Get the index and strip quotes if any
// These are the parameters for the indexing. Only care about one indexStr = objName.Substring(indexOpen + 1, indexClose - indexOpen - 1).Replace("\"", "");
var indexParams = indexedPropInfo.GetIndexParameters(); objName = objName.Substring(0, indexOpen);
if (indexParams.Length > 0) Debug.LogMessage(LogEventLevel.Information, dev, " Checking for collection '{0}', index '{1}'", objName, indexStr);
{ }
Debug.LogMessage(LogEventLevel.Information, " Indexed, param type: {0}", indexParams[0].ParameterType.Name);
var properParam = Convert.ChangeType(indexStr, indexParams[0].ParameterType,
System.Globalization.CultureInfo.InvariantCulture);
try
{
obj = indexedPropInfo.GetValue(collection, new object[] { properParam });
}
// if the index is bad, catch it here.
catch (TargetInvocationException e)
{
if (e.InnerException is ArgumentOutOfRangeException)
Debug.LogMessage(LogEventLevel.Information, " Index Out of range");
else if (e.InnerException is KeyNotFoundException)
Debug.LogMessage(LogEventLevel.Information, " Key not found");
return null;
}
}
} Type oType = obj.GetType();
else var prop = oType.GetProperty(objName);
obj = prop.GetValue(obj, null); if (prop == null)
} {
} Debug.LogMessage(LogEventLevel.Information, dev, "Property {0} not found on {1}", objName, path[i - 1]);
return obj; return null;
} }
// if there's an index, try to get the property
if (indexStr != null)
{
if (!typeof(ICollection).IsAssignableFrom(prop.PropertyType))
{
Debug.LogMessage(LogEventLevel.Information, dev, "Property {0} is not collection", objName);
return null;
}
var collection = prop.GetValue(obj, null) as ICollection;
// Get the indexed items "property"
var indexedPropInfo = prop.PropertyType.GetProperty("Item");
// These are the parameters for the indexing. Only care about one
var indexParams = indexedPropInfo.GetIndexParameters();
if (indexParams.Length > 0)
{
Debug.LogMessage(LogEventLevel.Information, " Indexed, param type: {0}", indexParams[0].ParameterType.Name);
var properParam = Convert.ChangeType(indexStr, indexParams[0].ParameterType,
System.Globalization.CultureInfo.InvariantCulture);
try
{
obj = indexedPropInfo.GetValue(collection, new object[] { properParam });
}
// if the index is bad, catch it here.
catch (TargetInvocationException e)
{
if (e.InnerException is ArgumentOutOfRangeException)
Debug.LogMessage(LogEventLevel.Information, " Index Out of range");
else if (e.InnerException is KeyNotFoundException)
Debug.LogMessage(LogEventLevel.Information, " Key not found");
return null;
}
}
}
else
obj = prop.GetValue(obj, null);
}
}
return obj;
}
/// <summary> /// <summary>
/// Sets a property on an object. /// Sets a property on an object.
@@ -308,78 +365,85 @@ namespace PepperDash.Essentials.Core
//return JsonConvert.SerializeObject(props, Formatting.Indented); //return JsonConvert.SerializeObject(props, Formatting.Indented);
} }
}
public class DeviceActionWrapper }
{
public string DeviceKey { get; set; }
public string MethodName { get; set; }
public object[] Params { get; set; }
}
public class PropertyNameType public class DeviceActionWrapper
{ {
object Parent; public string DeviceKey { get; set; }
public string MethodName { get; set; }
public object[] Params { get; set; }
}
[JsonIgnore] public class PropertyNameType
public PropertyInfo PropInfo { get; private set; } {
public string Name { get { return PropInfo.Name; } } private object Parent;
public string Type { get { return PropInfo.PropertyType.Name; } }
public string Value { get [JsonIgnore]
public PropertyInfo PropInfo { get; private set; }
public string Name { get { return PropInfo.Name; } }
public string Type { get { return PropInfo.PropertyType.Name; } }
public string Value
{ {
if (PropInfo.CanRead) get
{ {
try if (PropInfo.CanRead)
{ {
return PropInfo.GetValue(Parent, null).ToString(); try
{
return PropInfo.GetValue(Parent, null).ToString();
}
catch (Exception)
{
return null;
}
} }
catch (Exception) else
{
return null; return null;
}
} }
else }
return null;
} }
public bool CanRead { get { return PropInfo.CanRead; } } public bool CanRead { get { return PropInfo.CanRead; } }
public bool CanWrite { get { return PropInfo.CanWrite; } } public bool CanWrite { get { return PropInfo.CanWrite; } }
public PropertyNameType(PropertyInfo info, object parent) public PropertyNameType(PropertyInfo info, object parent)
{ {
PropInfo = info; PropInfo = info;
Parent = parent; Parent = parent;
} }
} }
public class MethodNameParams public class MethodNameParams
{ {
[JsonIgnore] [JsonIgnore]
public MethodInfo MethodInfo { get; private set; } public MethodInfo MethodInfo { get; private set; }
public string Name { get { return MethodInfo.Name; } } public string Name { get { return MethodInfo.Name; } }
public IEnumerable<NameType> Params { get { public IEnumerable<NameType> Params
return MethodInfo.GetParameters().Select(p => {
new NameType { Name = p.Name, Type = p.ParameterType.Name }); get
} } {
return MethodInfo.GetParameters().Select(p =>
new NameType { Name = p.Name, Type = p.ParameterType.Name });
}
}
public MethodNameParams(MethodInfo info) public MethodNameParams(MethodInfo info)
{ {
MethodInfo = info; MethodInfo = info;
} }
} }
public class NameType public class NameType
{ {
public string Name { get; set; } public string Name { get; set; }
public string Type { get; set; } public string Type { get; set; }
} }
[AttributeUsage(AttributeTargets.All)] [AttributeUsage(AttributeTargets.All)]
public class ApiAttribute : Attribute public class ApiAttribute : Attribute
{ {
} }
} }