iobroker.pvnode 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/main.js CHANGED
@@ -15,7 +15,7 @@
15
15
  const utils = require('@iobroker/adapter-core');
16
16
  const { PvnodeApi, PvnodeError } = require('./lib/api');
17
17
  const { prepare, computeStates, chartSeries, WEATHER_FIELDS } = require('./lib/compute');
18
- const { CHANNELS, commonFor } = require('./lib/states');
18
+ const { CHANNELS, FIXED, REFRESH_NAME, commonFor, channelName, stringChannelName } = require('./lib/states');
19
19
  const { localDate, isoLocal } = require('./lib/time');
20
20
  const { dayChart, daysChart } = require('./lib/svg');
21
21
 
@@ -37,6 +37,21 @@ function compass(deg) {
37
37
  return names[Math.round((((deg % 360) + 360) % 360) / 45) % 8];
38
38
  }
39
39
 
40
+ /**
41
+ * Quota header value as number: "unmetered" (plans without a cap) = -1, unknown = null.
42
+ *
43
+ * @param {unknown} v parsed header value
44
+ */
45
+ function quotaNumber(v) {
46
+ if (typeof v === 'number' && Number.isFinite(v)) {
47
+ return v;
48
+ }
49
+ if (typeof v === 'string' && v.trim().toLowerCase() === 'unmetered') {
50
+ return -1;
51
+ }
52
+ return null;
53
+ }
54
+
40
55
  class Pvnode extends utils.Adapter {
41
56
  constructor(options = {}) {
42
57
  super({ ...options, name: 'pvnode' });
@@ -385,21 +400,9 @@ class Pvnode extends utils.Adapter {
385
400
  // charts are only rebuilt when a new payload arrives
386
401
  const now = Date.now();
387
402
  const today = localDate(now, tz);
388
- await this.ensureState('json.forecast', {
389
- type: 'string',
390
- role: 'json',
391
- name: { en: 'Full forecast series', de: 'Komplette Prognosekurve' },
392
- });
393
- await this.ensureState('json.today', {
394
- type: 'string',
395
- role: 'json',
396
- name: { en: 'Forecast series today', de: 'Prognosekurve heute' },
397
- });
398
- await this.ensureState('json.daily', {
399
- type: 'string',
400
- role: 'json',
401
- name: { en: 'Daily forecast', de: 'Tagesprognose' },
402
- });
403
+ for (const id of ['json.forecast', 'json.today', 'json.daily']) {
404
+ await this.ensureState(id);
405
+ }
403
406
  await this.setStateAsync('json.forecast', JSON.stringify(chartSeries(this.prepared)), true);
404
407
  await this.setStateAsync(
405
408
  'json.today',
@@ -446,19 +449,11 @@ class Pvnode extends utils.Adapter {
446
449
  'html.days': () => daysChart(p, now, opt),
447
450
  };
448
451
  for (const [id, fn] of Object.entries(charts)) {
449
- await this.ensureState(id, { type: 'string', role: 'html', name: this.chartName(id) });
452
+ await this.ensureState(id);
450
453
  await this.setStateAsync(id, fn(), true);
451
454
  }
452
455
  }
453
456
 
454
- chartName(id) {
455
- return {
456
- 'html.today': { en: 'SVG chart: power curve today', de: 'SVG-Diagramm: Leistungskurve heute' },
457
- 'html.tomorrow': { en: 'SVG chart: power curve tomorrow', de: 'SVG-Diagramm: Leistungskurve morgen' },
458
- 'html.days': { en: 'SVG chart: daily energy', de: 'SVG-Diagramm: Tagesertrag' },
459
- }[id];
460
- }
461
-
462
457
  startComputeTimer() {
463
458
  const now = Date.now();
464
459
  const toNext = COMPUTE_INTERVAL_MS - (now % COMPUTE_INTERVAL_MS) + 2000;
@@ -474,94 +469,27 @@ class Pvnode extends utils.Adapter {
474
469
  // ------------------------------------------------------------------ objects
475
470
 
476
471
  async createBaseObjects() {
472
+ // extendObject (not setObjectNotExists) so that existing installations get updated names/types
477
473
  for (const [ch, name] of Object.entries(CHANNELS)) {
478
- await this.setObjectNotExistsAsync(ch, { type: 'channel', common: { name }, native: {} });
474
+ await this.extendObjectAsync(ch, { type: 'channel', common: { name }, native: {} });
475
+ this.created.add(ch);
479
476
  }
480
- const info = {
481
- 'info.connection': {
482
- type: 'boolean',
483
- role: 'indicator.connected',
484
- name: { en: 'Connected to pvnode', de: 'Verbunden mit pvnode' },
485
- },
486
- 'info.stale': {
487
- type: 'boolean',
488
- role: 'indicator',
489
- name: {
490
- en: 'Forecast is outdated (last request failed)',
491
- de: 'Prognose veraltet (letzte Abfrage fehlgeschlagen)',
492
- },
493
- },
494
- 'info.lastError': { type: 'string', role: 'text', name: { en: 'Last error', de: 'Letzter Fehler' } },
495
- 'info.lastUpdate': {
496
- type: 'string',
497
- role: 'date',
498
- name: { en: 'Last successful request', de: 'Letzte erfolgreiche Abfrage' },
499
- },
500
- 'info.computedAt': {
501
- type: 'string',
502
- role: 'text',
503
- name: { en: 'Forecast computed at (pvnode)', de: 'Prognose berechnet um (pvnode)' },
504
- },
505
- 'info.nextPoll': { type: 'string', role: 'date', name: { en: 'Next request', de: 'Nächste Abfrage' } },
506
- 'info.requestsLimit': {
507
- type: 'mixed',
508
- role: 'value',
509
- name: { en: 'Monthly request limit', de: 'Monatliches Anfragelimit' },
510
- },
511
- 'info.requestsUsed': {
512
- type: 'number',
513
- role: 'value',
514
- name: { en: 'Requests used this month', de: 'Anfragen diesen Monat verbraucht' },
515
- },
516
- 'info.requestsRemaining': {
517
- type: 'mixed',
518
- role: 'value',
519
- name: { en: 'Requests remaining this month', de: 'Verbleibende Anfragen diesen Monat' },
520
- },
521
- 'info.requestsReset': {
522
- type: 'string',
523
- role: 'date',
524
- name: { en: 'Request counter reset', de: 'Zurücksetzung des Anfragezählers' },
525
- },
526
- 'info.availableGroups': {
527
- type: 'string',
528
- role: 'text',
529
- name: { en: 'Data groups allowed by plan', de: 'Vom Plan erlaubte Datengruppen' },
530
- },
531
- 'info.variability': {
532
- type: 'boolean',
533
- role: 'indicator',
534
- name: { en: 'Variability band available', de: 'Schwankungsband verfügbar' },
535
- },
536
- 'info.forecastDays': {
537
- type: 'number',
538
- role: 'value',
539
- name: { en: 'Number of forecast days', de: 'Anzahl Prognosetage' },
540
- },
541
- 'info.cache': {
542
- type: 'string',
543
- role: 'json',
544
- name: { en: 'Cached forecast (internal)', de: 'Zwischengespeicherte Prognose (intern)' },
545
- },
546
- 'site.name': { type: 'string', role: 'text', name: { en: 'Site name', de: 'Name des Standorts' } },
547
- 'site.id': { type: 'string', role: 'text', name: { en: 'Site ID', de: 'Standort-ID' } },
548
- 'site.power_kw': {
549
- type: 'number',
550
- role: 'value',
551
- unit: 'kWp',
552
- name: { en: 'Installed power', de: 'Installierte Leistung' },
553
- },
554
- };
555
- for (const [id, c] of Object.entries(info)) {
556
- await this.ensureState(id, c);
477
+ for (const id of Object.keys(FIXED)) {
478
+ if (id.startsWith('info.') || id.startsWith('site.')) {
479
+ await this.ensureState(id);
480
+ }
557
481
  }
558
- await this.setObjectNotExistsAsync('control.refresh', {
482
+ // up to 0.2.2 requestsLimit/requestsRemaining were "mixed" and could hold the text "unmetered"
483
+ for (const id of ['info.requestsLimit', 'info.requestsRemaining']) {
484
+ const st = await this.getStateAsync(id);
485
+ if (st && st.val !== null && typeof st.val !== 'number') {
486
+ await this.setStateAsync(id, quotaNumber(st.val), true);
487
+ }
488
+ }
489
+ await this.extendObjectAsync('control.refresh', {
559
490
  type: 'state',
560
491
  common: {
561
- name: {
562
- en: 'Refresh forecast now (costs one request)',
563
- de: 'Prognose jetzt abrufen (kostet eine Anfrage)',
564
- },
492
+ name: REFRESH_NAME,
565
493
  type: 'boolean',
566
494
  role: 'button',
567
495
  read: false,
@@ -581,9 +509,9 @@ class Pvnode extends utils.Adapter {
581
509
  for (let i = 2; i < parts.length; i++) {
582
510
  const ch = parts.slice(0, i).join('.');
583
511
  if (!this.created.has(ch)) {
584
- await this.setObjectNotExistsAsync(ch, {
512
+ await this.extendObjectAsync(ch, {
585
513
  type: 'channel',
586
- common: { name: this.channelName(ch) },
514
+ common: { name: channelName(ch) },
587
515
  native: {},
588
516
  });
589
517
  this.created.add(ch);
@@ -596,24 +524,6 @@ class Pvnode extends utils.Adapter {
596
524
  this.created.add(id);
597
525
  }
598
526
 
599
- channelName(ch) {
600
- const [root, idx] = ch.split('.');
601
- if (root === 'days') {
602
- const n = Number(idx);
603
- if (n === 0) {
604
- return { en: 'Today', de: 'Heute' };
605
- }
606
- if (n === 1) {
607
- return { en: 'Tomorrow', de: 'Morgen' };
608
- }
609
- return { en: `In ${n} days`, de: `In ${n} Tagen` };
610
- }
611
- if (root === 'strings') {
612
- return { en: `String ${Number(idx) + 1}`, de: `String ${Number(idx) + 1}` };
613
- }
614
- return ch;
615
- }
616
-
617
527
  async removeSurplus(root, count, max) {
618
528
  for (let i = count; i < max; i++) {
619
529
  const id = `${root}.${i}`;
@@ -701,9 +611,7 @@ class Pvnode extends utils.Adapter {
701
611
  const ch = `strings.${i}`;
702
612
  await this.extendObjectAsync(ch, {
703
613
  type: 'channel',
704
- common: {
705
- name: `String ${i + 1}: ${compass(s.orientation)} ${s.orientation}°, ${s.slope}° Neigung, ${s.power_kw} kWp`,
706
- },
614
+ common: { name: stringChannelName(i, s) },
707
615
  native: { string_id: s.id },
708
616
  });
709
617
  this.created.add(ch);
@@ -720,9 +628,9 @@ class Pvnode extends utils.Adapter {
720
628
  if (!q) {
721
629
  return;
722
630
  }
723
- await this.setStateAsync('info.requestsLimit', q.limit ?? null, true);
631
+ await this.setStateAsync('info.requestsLimit', quotaNumber(q.limit), true);
724
632
  await this.setStateAsync('info.requestsUsed', typeof q.used === 'number' ? q.used : null, true);
725
- await this.setStateAsync('info.requestsRemaining', q.remaining ?? null, true);
633
+ await this.setStateAsync('info.requestsRemaining', quotaNumber(q.remaining), true);
726
634
  await this.setStateAsync('info.requestsReset', q.reset || null, true);
727
635
  }
728
636
  }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "iobroker.pvnode",
3
- "version": "0.2.1",
3
+ "version": "0.2.3",
4
4
  "description": "PV production forecast from pvnode.com (API v2) for ioBroker",
5
5
  "author": {
6
6
  "name": "AlPi-BRV",
7
- "email": "AlPi-BRV@users.noreply.github.com"
7
+ "email": "alex@1-5worlds.de"
8
8
  },
9
9
  "homepage": "https://github.com/AlPi-BRV/ioBroker.pvnode",
10
10
  "license": "MIT",