Use accurate display (service) names for sensors. Added TODO/Roadmap for future development and testing.

Author: gorhack

README.md

@@ -4,6 +4,21 @@
 
 </p>
 
+# Ideal Sciences Temp Stick Homebridge Plugin
+
+This is an unnofficial plugin to use your [Temp Stick](https://tempstick.com/) sensor with Homebridge.
+
+You will need your API key, provided in your [account](https://mytempstick.com/account#developers) settings.
+
+### Development Roadmap:
+- [x] Discover all sensors and probes
+- [x] Ambient temperature, ambient humidity, and probe temperature
+- [ ] Handle API errors gracefully
+- [ ] Use offsets (`probe_temp_offset`, `humidity_offset`, `temp_offset`) for calibrated sensors
+- [ ] Request latest readings based on `send_interval` and `next_checkin`
+- [ ] Request updated documentation in [API](https://tempstickapi.com/docs/) for undocumented parameters
+(`last_tcTemp`, for example)
+
 <span align="center">
 
 # Homebridge Platform Plugin Template

package.json

@@ -1,5 +1,4 @@
 {
-  "private": true,
   "displayName": "TempStick",
   "name": "homebridge-tempstick",
   "version": "1.0.0",

src/platform.ts

@@ -126,7 +126,7 @@ export class TempStickHomebridgePlatform implements DynamicPlatformPlugin {
         });
 
       } catch (err) {
-        // TODO: Catch 406 and other errors and handle gracefully
+        // TODO: Catch 406 and other errors (bad API key, network issue, etc) and handle gracefully
         if (err instanceof TypeError) {
           this.log.error(err.message);
         }

src/platformAccessory.ts

@@ -47,21 +47,24 @@ export class TempStickAccessory {
     // Example: add two "motion sensor" services to the accessory
     const ambientTemperatureService = this.accessory.getService('Ambient Temperature Sensor') ||
       this.accessory.addService(this.platform.Service.TemperatureSensor, 'Ambient Temperature Sensor', 'AmbientTemperatureSensor');
+    ambientTemperatureService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName + ' Ambient Temp Sensor');
+
 
     // undocumented in V1 API, TODO: test if this exists without a probe
     const probe = !!accessory.context.device.last_tcTemp;
     let probeTemperatureService: Service | undefined = undefined;
     if (probe) {
       probeTemperatureService = this.accessory.getService('Probe Temperature Sensor') ||
           this.accessory.addService(this.platform.Service.TemperatureSensor, 'Probe Temperature Sensor', 'ProbeTemperatureSensor');
+      probeTemperatureService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName + ' Probe Temp Sensor');
     }
 
     this.service = this.accessory.getService(this.platform.Service.HumiditySensor)
                     || this.accessory.addService(this.platform.Service.HumiditySensor);
 
     // set the service name, this is what is displayed as the default name on the Home app
     // in this example we are using the name we stored in the `accessory.context` in the `discoverDevices` method.
-    this.service.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+    this.service.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName + ' Humidity Sensor');
 
     // each service must implement at-minimum the "required characteristics" for the given service type
     // see https://developers.homebridge.io/#/service/Lightbulb