Refactor characteristics

jdomnitz · jdomnitz · commit 17dcdaa52689 · 2024-11-12T22:10:26.000-05:00
diff --git a/HomeKitDotNet/HomeKitDotNet.csproj b/HomeKitDotNet/HomeKitDotNet.csproj
@@ -18,6 +18,13 @@
 	<PackageIcon>logo.png</PackageIcon>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <ItemGroup>
     <None Update="logo.png">
       <Pack>True</Pack>
diff --git a/HomeKitDotNet/Models/Characteristic.cs b/HomeKitDotNet/Models/Characteristic.cs
@@ -15,15 +15,10 @@
 
 namespace HomeKitDotNet.Models
 {
-    public class Characteristic<T> : ICharacteristic where T : struct
+    public class Characteristic<T> : CharacteristicBase where T : struct
     {
-        private Service service;
-        private CharacteristicJSON _json;
-        protected Characteristic(Service service, CharacteristicJSON json)
+        protected Characteristic(Service service, CharacteristicJSON json) : base(service, json)
         {
-            this.service = service;
-            this._json = json;
-            this.Type = json.Type;
             MapValue(json.Value);
         }
 
@@ -52,13 +47,6 @@ protected async Task<bool> Write(T value)
             return LastValue;
         }
 
-        protected async Task Subscribe()
-        {
-            if (!CanSubscribe)
-                throw new InvalidOperationException("Subscriptions are prohibited");
-            //TODO
-        }
-
         protected void MapValue(JsonElement? value)
         {
             if (value.HasValue)
@@ -88,21 +76,11 @@ protected void MapValue(JsonElement? value)
                 LastValue = null;
         }
 
-        public string Type { get; init; }
         public T? LastValue { get; private set; }
-        public int InstanceID => _json.InstanceID;
-        public CharacteristicPermission[] Permissions => _json.Permissions;
-        public string? Description => _json.Description;
-        public string? Unit => _json.Description;
         public float? MinValue => _json.MinValue;
         public float? MaxValue => _json.MaxValue;
         public float? MinStep => _json.MinStep;
         public float[]? ValidValues => _json.ValidValues;
         public float[]? ValidValuesRange => _json.ValidValuesRange;
-
-
-        public bool CanRead { get { return Permissions.Contains(CharacteristicPermission.pr); } }
-        public bool CanWrite { get { return Permissions.Contains(CharacteristicPermission.pw); } }
-        public bool CanSubscribe { get { return Permissions.Contains(CharacteristicPermission.ev); } }
     }
 }
diff --git a/HomeKitDotNet/Models/CharacteristicBase.cs b/HomeKitDotNet/Models/CharacteristicBase.cs
@@ -0,0 +1,39 @@
+﻿using HomeKitDotNet.JSON;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace HomeKitDotNet.Models
+{
+    public class CharacteristicBase
+    {
+        protected Service service;
+        protected CharacteristicJSON _json;
+
+        public CharacteristicBase(Service service, CharacteristicJSON json)
+        {
+            this._json = json;
+            this.Type = json.Type;
+            this.service = service;
+        }
+
+        protected async Task<bool> Events(bool subscribe)
+        {
+            if (!CanSubscribe)
+                throw new InvalidOperationException("Subscriptions are prohibited");
+            //TODO
+            return false;
+        }
+
+        public string Type { get; init; }
+        public int InstanceID => _json.InstanceID;
+        public string? Description => _json.Description;
+        public string? Unit => _json.Description;
+        public CharacteristicPermission[] Permissions => _json.Permissions;
+        public bool CanRead { get { return Permissions.Contains(CharacteristicPermission.pr); } }
+        public bool CanWrite { get { return Permissions.Contains(CharacteristicPermission.pw); } }
+        public bool CanSubscribe { get { return Permissions.Contains(CharacteristicPermission.ev); } }
+    }
+}
diff --git a/HomeKitDotNet/Models/ICharacteristic.cs b/HomeKitDotNet/Models/ICharacteristic.cs
diff --git a/HomeKitDotNet/Models/Service.cs b/HomeKitDotNet/Models/Service.cs
@@ -25,7 +25,7 @@ protected Service(Accessory accessory, string type)
         public string Type { get; init; }
         public Accessory Accessory { get; init; }
 
-        protected ICharacteristic? GetCharacteristic(string type, ServiceJSON service)
+        protected CharacteristicBase? GetCharacteristic(string type, ServiceJSON service)
         {
             CharacteristicJSON? json = service.Characteristics.FirstOrDefault(c => c.Type == type);
             switch (type)
diff --git a/HomeKitDotNet/Models/StringCharacteristic.cs b/HomeKitDotNet/Models/StringCharacteristic.cs
@@ -3,16 +3,11 @@
 
 namespace HomeKitDotNet.Models
 {
-    public class StringCharacteristic : ICharacteristic
+    public class StringCharacteristic : CharacteristicBase
     {
-        private Service service;
-        private CharacteristicJSON _json;
-        protected StringCharacteristic(Service service, CharacteristicJSON json)
+        protected StringCharacteristic(Service service, CharacteristicJSON json) : base(service, json)
         {
-            this._json = json;
-            this.Type = json.Type;
             MapValue(json.Value);
-            this.service = service;
         }
 
         protected async Task<bool> Write(string value)
@@ -40,11 +35,6 @@ protected async Task<bool> Write(string value)
             return LastValue;
         }
 
-        protected async Task Subscribe()
-        {
-            //TODO
-        }
-
         protected void MapValue(JsonElement? value)
         {
             if (value.HasValue)
@@ -58,18 +48,8 @@ protected void MapValue(JsonElement? value)
                 LastValue = null;
         }
 
-        public string Type { get; init; }
         public string? LastValue { get; set; }
-        public int InstanceID => _json.InstanceID;
-        public CharacteristicPermission[] Permissions => _json.Permissions;
-
-        public string? Description => _json.Description;
-        public string? Unit => _json.Description;
         public float? MaxLength => _json.MaxLength;
         public float? MaxDataLength => _json.MaxDataLength;
-
-        public bool CanRead { get { return Permissions.Contains(CharacteristicPermission.pr); } }
-        public bool CanWrite { get { return Permissions.Contains(CharacteristicPermission.pw); } }
-        public bool CanSubscribe { get { return Permissions.Contains(CharacteristicPermission.ev); } }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,15 +15,10 @@`
`15`	`15`
`16`	`16`	`namespace HomeKitDotNet.Models`
`17`	`17`	`{`
`18`		`- public class Characteristic<T> : ICharacteristic where T : struct`
	`18`	`+ public class Characteristic<T> : CharacteristicBase where T : struct`
`19`	`19`	`{`
`20`		`- private Service service;`
`21`		`- private CharacteristicJSON _json;`
`22`		`- protected Characteristic(Service service, CharacteristicJSON json)`
	`20`	`+ protected Characteristic(Service service, CharacteristicJSON json) : base(service, json)`
`23`	`21`	`{`
`24`		`- this.service = service;`
`25`		`- this._json = json;`
`26`		`- this.Type = json.Type;`
`27`	`22`	`MapValue(json.Value);`
`28`	`23`	`}`
`29`	`24`
`@@ -52,13 +47,6 @@ protected async Task<bool> Write(T value)`
`52`	`47`	`return LastValue;`
`53`	`48`	`}`
`54`	`49`
`55`		`- protected async Task Subscribe()`
`56`		`- {`
`57`		`- if (!CanSubscribe)`
`58`		`- throw new InvalidOperationException("Subscriptions are prohibited");`
`59`		`- //TODO`
`60`		`- }`
`61`		`-`
`62`	`50`	`protected void MapValue(JsonElement? value)`
`63`	`51`	`{`
`64`	`52`	`if (value.HasValue)`
`@@ -88,21 +76,11 @@ protected void MapValue(JsonElement? value)`
`88`	`76`	`LastValue = null;`
`89`	`77`	`}`
`90`	`78`
`91`		`- public string Type { get; init; }`
`92`	`79`	`public T? LastValue { get; private set; }`
`93`		`- public int InstanceID => _json.InstanceID;`
`94`		`- public CharacteristicPermission[] Permissions => _json.Permissions;`
`95`		`- public string? Description => _json.Description;`
`96`		`- public string? Unit => _json.Description;`
`97`	`80`	`public float? MinValue => _json.MinValue;`
`98`	`81`	`public float? MaxValue => _json.MaxValue;`
`99`	`82`	`public float? MinStep => _json.MinStep;`
`100`	`83`	`public float[]? ValidValues => _json.ValidValues;`
`101`	`84`	`public float[]? ValidValuesRange => _json.ValidValuesRange;`
`102`		`-`
`103`		`-`
`104`		`- public bool CanRead { get { return Permissions.Contains(CharacteristicPermission.pr); } }`
`105`		`- public bool CanWrite { get { return Permissions.Contains(CharacteristicPermission.pw); } }`
`106`		`- public bool CanSubscribe { get { return Permissions.Contains(CharacteristicPermission.ev); } }`
`107`	`85`	`}`
`108`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ protected Service(Accessory accessory, string type)`
`25`	`25`	`public string Type { get; init; }`
`26`	`26`	`public Accessory Accessory { get; init; }`
`27`	`27`
`28`		`- protected ICharacteristic? GetCharacteristic(string type, ServiceJSON service)`
	`28`	`+ protected CharacteristicBase? GetCharacteristic(string type, ServiceJSON service)`
`29`	`29`	`{`
`30`	`30`	`CharacteristicJSON? json = service.Characteristics.FirstOrDefault(c => c.Type == type);`
`31`	`31`	`switch (type)`
Original file line number	Diff line number	Diff line change
`@@ -3,16 +3,11 @@`
`3`	`3`
`4`	`4`	`namespace HomeKitDotNet.Models`
`5`	`5`	`{`
`6`		`- public class StringCharacteristic : ICharacteristic`
	`6`	`+ public class StringCharacteristic : CharacteristicBase`
`7`	`7`	`{`
`8`		`- private Service service;`
`9`		`- private CharacteristicJSON _json;`
`10`		`- protected StringCharacteristic(Service service, CharacteristicJSON json)`
	`8`	`+ protected StringCharacteristic(Service service, CharacteristicJSON json) : base(service, json)`
`11`	`9`	`{`
`12`		`- this._json = json;`
`13`		`- this.Type = json.Type;`
`14`	`10`	`MapValue(json.Value);`
`15`		`- this.service = service;`
`16`	`11`	`}`
`17`	`12`
`18`	`13`	`protected async Task<bool> Write(string value)`
`@@ -40,11 +35,6 @@ protected async Task<bool> Write(string value)`
`40`	`35`	`return LastValue;`
`41`	`36`	`}`
`42`	`37`
`43`		`- protected async Task Subscribe()`
`44`		`- {`
`45`		`- //TODO`
`46`		`- }`
`47`		`-`
`48`	`38`	`protected void MapValue(JsonElement? value)`
`49`	`39`	`{`
`50`	`40`	`if (value.HasValue)`
`@@ -58,18 +48,8 @@ protected void MapValue(JsonElement? value)`
`58`	`48`	`LastValue = null;`
`59`	`49`	`}`
`60`	`50`
`61`		`- public string Type { get; init; }`
`62`	`51`	`public string? LastValue { get; set; }`
`63`		`- public int InstanceID => _json.InstanceID;`
`64`		`- public CharacteristicPermission[] Permissions => _json.Permissions;`
`65`		`-`
`66`		`- public string? Description => _json.Description;`
`67`		`- public string? Unit => _json.Description;`
`68`	`52`	`public float? MaxLength => _json.MaxLength;`
`69`	`53`	`public float? MaxDataLength => _json.MaxDataLength;`
`70`		`-`
`71`		`- public bool CanRead { get { return Permissions.Contains(CharacteristicPermission.pr); } }`
`72`		`- public bool CanWrite { get { return Permissions.Contains(CharacteristicPermission.pw); } }`
`73`		`- public bool CanSubscribe { get { return Permissions.Contains(CharacteristicPermission.ev); } }`
`74`	`54`	`}`
`75`	`55`	`}`