[V4] Dev service Withings

euguuu · May 21, 2020, 4:12pm

Hello,

I am trying to develop a service that retrieves data from devices of this brand.

Once the information is retrieved from the account and the devices, I want to retrieve all the historical measurement data.

I create feature_states for each measurement by defining the created_date and the updated_date, but after saving, these 2 dates are forced to the current date and not to what I defined.

How can I save device measurements from the past?

pierre-gilles · May 25, 2020, 8:45am

Hello @euguuu! Great if you develop this service, I saw your PR

Good point, this is indeed the current behavior, see the incriminating line of code:

github.com/GladysAssistant/Gladys

server/lib/device/device.saveState.js

master


      
          * @description Save new device feature state in DB.
          * @param {object} deviceFeature - A DeviceFeature object.
          * @param {number} newValue - The new value of the deviceFeature to save.
          * @example
          * saveState({
          *   id: 'fc235c88-b10d-4706-8b59-fef92a7119b2',
          *   selector: 'my-light'
          * }, 12);
          */
          async function saveState(deviceFeature, newValue) {
           if (Number.isNaN(newValue)) {
             throw new BadParameters(`device.saveState of NaN value on ${deviceFeature.selector}`);
           }
          
           logger.debug(`device.saveState of deviceFeature ${deviceFeature.selector}`);
           const now = new Date();
           const previousDeviceFeature = this.stateManager.get('deviceFeature', deviceFeature.selector);
           const previousDeviceFeatureValue = previousDeviceFeature ? previousDeviceFeature.last_value : null;
           // save local state in RAM
           this.stateManager.setState('deviceFeature', deviceFeature.selector, {
             last_value: newValue,

Could you describe in more detail the expected behavior of your service so we can see how to do the best?

euguuu · May 25, 2020, 1:12pm

In this service, I start by requesting the information to connect the user’s Withings account (via OAuth2).

Once the connection is validated, I retrieve the account information to create the existing devices in this account (scale, watch, etc.) and I create the associated features (battery, weight, pulse, etc.). I also retrieve the history of existing measurements, and I would like to record these measurements (with their actual creation dates) to have the history in Gladys and allow display in the form of a curve, for example.

Once all this is done, I want to set up a poll to retrieve new measurements once a day. In my case, it is not the time when Gladys retrieves the measurements that counts, but the creation date of the measurement by the device on the Withings account.

pierre-gilles · May 26, 2020, 8:57am

Got it, I see the idea!

Since you’re syncing a lot of values at once, I don’t think the current function makes sense.

What we need is to create a function like the saveState function, but instead of taking 1 value, it takes an array of values.

This function would:

Insert the list of t_device_feature_state in the DB
Update the t_device_feature.last_value with the last value of the array
Call the scenes with the last value and propagate the last value via websockets to connected clients

Basically, copy this function:

github.com/GladysAssistant/Gladys

server/lib/device/device.saveState.js

master

const db = require('../../models');
const logger = require('../../utils/logger');
const { EVENTS, WEBSOCKET_MESSAGE_TYPES } = require('../../utils/constants');
const { BadParameters } = require('../../utils/coreErrors');

/**
 * @description Save new device feature state in DB.
 * @param {object} deviceFeature - A DeviceFeature object.
 * @param {number} newValue - The new value of the deviceFeature to save.
 * @example
 * saveState({
 *   id: 'fc235c88-b10d-4706-8b59-fef92a7119b2',
 *   selector: 'my-light'
 * }, 12);
 */
async function saveState(deviceFeature, newValue) {
  if (Number.isNaN(newValue)) {
    throw new BadParameters(`device.saveState of NaN value on ${deviceFeature.selector}`);
  }

Ce fichier a été tronqué. afficher l'original

To handle multiple insertions.

Then listen to a new event, like EVENTS.DEVICE.NEW_STATE_SYNC in the same way as EVENTS.DEVICE.NEW_STATE

github.com/GladysAssistant/Gladys

server/lib/device/index.js

master


      
          const { purgeAllSqliteStates } = require('./device.purgeAllSqliteStates');
          const { updateFeature } = require('./device.updateFeature');
          const { saveMultipleHistoricalStates } = require('./device.saveMultipleHistoricalStates');
          const { getOldestStateFromDeviceFeatures } = require('./device.getOldestStateFromDeviceFeatures');
          const { destroyParam } = require('./device.destroyParam');
          const { destroyStatesFrom } = require('./device.destroyStatesFrom');
          
          const DeviceManager = function DeviceManager(
            eventManager,
            messageManager,
            stateManager,
            serviceManager,
            roomManager,
            variable,
            job,
            brain,
            user,
          ) {
            this.eventManager = eventManager;
            this.messageManager = messageManager;
            this.stateManager = stateManager;

Could you take care of this in your PR?

Don’t hesitate if you have any questions!

euguuu · June 15, 2020, 6:53pm

Hello,

I need to get back to it, but yes I will take care of integrating this modification.

euguuu · November 16, 2020, 10:56pm

Hello,

I’ve made significant progress on this development. I’ve just pushed a nearly final version of the PR [WIP] Withings.

This integration allows:

Connecting to the Withings account
A generic API (server & front) to connect to OAuth2 services (to be confirmed on other integrations)
Automatic creation of Withings devices
Retrieving device measurements
Displaying a ‹ Health › box in the dashboard similar to the DeviceInRoom box

The remaining tasks to consider the integration correct are:

Integration documentation (in progress)
Adding a configuration for the demo site
Code review if possible and taking into account the remarks
[Optional] Testing the integration by volunteers with more devices (the integration should work for all Withings devices, but I only have one for now)

Ideally, for a next version, I would have liked to display a box on the dashboard in the form of a line graph. Are there components already planned to display the history of data?

Some images of the integration:

guim31 · November 17, 2020, 9:05am

Great all that! Thanks @euguuu
By any chance would it be possible to display a historical weight curve? Which is generally the whole interest of a connected scale. To be set as desired: 1 week / 1 month / 1 year.

Hamtaro · November 17, 2020, 9:48am

The question is also being asked

guim31 · November 17, 2020, 9:51am

Oh yes, actually if I could read I wouldn’t ask this kind of question… ^^
Sorry!

pierre-gilles · November 17, 2020, 4:41pm

Magnificent!!

That’s very nice work @euguuu

I think this is more something we want in general for Gladys, not just for this service. So I don’t think it’s necessary to develop this in the service.

We have this task that already has 12 votes:

I think that will solve the problem

Hamtaro · November 17, 2020, 4:59pm

I really liked v3 for that…

guim31 · November 17, 2020, 8:05pm

Great! Well, as I don’t understand how Gladys is built, I didn’t think we could create a « history » tool and use it on all the sensors we want. Thanks for the info!

VonOx · November 17, 2020, 10:20pm

Yes, currently the history is in the database, by the way when you configure Gladys for the first time you define what retention you want.

The feature needs to be developed.

euguuu · November 18, 2020, 8:15am

Is there any development ongoing at this display level? Have there already been decisions made about the technology to use or the architecture to implement, or do we need to start from scratch?

VonOx · November 18, 2020, 9:04am

This is where it happens

pierre-gilles · November 19, 2020, 7:57am

There is no development currently underway. We discussed this in the other topic, which is just a « to-do » list, but overall, everything needs to be done: choosing the chart library and development

Should we discuss this in the other topic?

AlexTrovato · March 16, 2021, 8:14pm

Hello everyone,
I’m bringing up the topic again.
@euguuu is nearing the end of development, the PR is under review, so we are looking for volunteers to test/validate the service, preferably with hardware.

Thanks in advance.

pierre-gilles · March 22, 2021, 2:50am

I’m bringing the topic back up, does anyone have equipment and could test the PR?

Otherwise, could we have a small presentation of the PR @euguuu?

What does it do? Which Withings devices are supported?

euguuu · March 22, 2021, 5:17pm

The associated documentation describes each page of the service step by step. I can do a demo if needed or provide my Withings codes (corresponds to OAuth2 as I can delete/change them with one click after testing).

I have only tested in real conditions with one device (the Body scale), but in theory, the service is compatible with all devices of the brand.

The service automatically creates devices based on those declared on the Withings profile, retrieves the history of measurements, and then performs a daily poll to retrieve new measurements.

In terms of measurement usage, there is a box similar to the device in-room box but which only retrieves features of the ‹ health › category.

pierre-gilles · March 23, 2021, 12:25am

Ok, and how do you handle the fact that these are health devices that are more « personal » than related to the home?

Your scale returns weights linked to people in your home (and not linked to rooms like most sensors so far), how did you think about that?

Topic		Replies	Views
Review des PR - J'ai besoin de vous! Développement	73	3520	April 10, 2021
Erreur / perte de connexion avec Service NetAtmo Configuration netatmo	29	190	March 28, 2025
Nouvelle version 4.7 : Affichage graphique et mise à jour majeure de l'intégration Zigbee2mqtt! Actualités	47	3950	April 8, 2022
Intégration HomeKit et Siri Développement	87	3071	December 3, 2025
[DB de 5Go] Lenteurs au premier démarrage Développement	26	1372	September 9, 2022

[V4] Dev service Withings

Related topics