Installation and requirements

What does SourceAnalytix require (Node.js, js-controller, Admin)?

In short: From v0.7.0, SourceAnalytix needs Node.js 22, js-controller 6.0.11 and Admin 8.0.0 or newer. Admin 8 is required because the instance settings page, with its "Overview" and "Problems" tabs, is built from Admin 8 components.

	from v0.7.0	v0.6.0 to v0.6.x
Node.js	22 or newer	22 or newer
js-controller	6.0.11 or newer	6.0.11 or newer
Admin	8.0.0 or newer	7.8.23 or newer

Check the versions in the console with iobroker -v (js-controller) and node -v (Node.js). If your system doesn't meet a requirement, update that component first and then SourceAnalytix. v0.6.0 to v0.6.x work with Admin 7.8 and with Admin 8. Older statements from the forum such as "works with Admin 6" no longer apply.

If SourceAnalytix doesn't start after a Node.js update

If the log shows TypeError: Class extends value … is not a constructor or null after a Node.js update, the js-controller is usually too old. Update the js-controller, run iob fix in the console and restart the instance. If ioBroker runs in Docker, update the container image instead and restore your backup if necessary.

See also: How do I update SourceAnalytix (and what is a downgrade)? · Problems with installation and the Admin display

How do I install SourceAnalytix and create an instance?

In short: In the ioBroker system settings, switch the repository to "latest" (beta) and install SourceAnalytix on the "Adapters" tab. Admin creates the instance sourceanalytix.0 for you. Then open the instance settings and set up your first source on the "Overview" tab.

At the moment SourceAnalytix is only available in the "latest" repository, not in "stable". It moves to "stable" after a test phase. With "stable" selected, you won't find it in the adapter list.

How to do it (from v0.7.0)

1. Check the requirements, especially Admin 8.
2. In Admin, open the system settings and select the "latest" (beta) repository under "Repositories" as the active repository.
3. Open the "Adapters" tab, refresh the adapter list and search for "SourceAnalytix".
4. Install the adapter. Admin creates the instance sourceanalytix.0 and starts it.
5. On the "Instances" tab, open the settings of sourceanalytix.0. The "Overview" tab shows the "Set up SourceAnalytix" card with the steps "Create a price", "Add a source" and "View the values".
6. On the "Price definitions" tab, create at least one price definition, for example for electricity in kWh, and save. Saving restarts the adapter.
7. On the "Overview" tab, click "Add first source". For what to do next, see Where do I configure SourceAnalytix for a datapoint?.

The "Overview" and "Problems" tabs need a running instance. If it is stopped, "Instance is not running" appears at the top with a "Start" button. All actions marked with ⚡ are locked until then.

There is no instance

If you installed SourceAnalytix from the console with npm or from a GitHub URL, ioBroker doesn't create an instance. Create it yourself with the plus icon, which adds an instance in Admin. One instance is enough for all sources.

NOTE

Installing from a GitHub URL is only meant for testing, when the developer asks for it. Admin doesn't show updates for such an installation. To get back to the "latest" repository, see How do I update SourceAnalytix (and what is a downgrade)?.

Up to v0.6.x: The instance settings only contain "Main settings" and "Price definitions". You enable sources there, on the datapoint on the "Objects" tab, with the wrench icon.

See also: Do I need several instances or versions side by side? · My first meter

Do I need several instances or versions side by side?

In short: No. One instance handles any number of sources, each with its own settings. You can't run two versions of SourceAnalytix side by side, because ioBroker installs exactly one version of each adapter.

One instance for everything

The settings of a source apply per instance. They are stored on the datapoint under common.custom.sourceanalytix.<instance>, and each instance only calculates the sources that are enabled for it. The "Overview" and "Problems" tabs also show only the sources of that instance. A second instance gains you nothing, unless you deliberately want separate folders sourceanalytix.0 and sourceanalytix.1.

Multiple instances always run the same installed version. So you can't test a new version next to the old one. Install it as an update after making a backup. To go back if something goes wrong, see Downgrade.

Removing an extra instance

A second instance often appears unnoticed, for example when you install SourceAnalytix from the repository again after a GitHub installation. To clean up:

1. On the "Objects" tab, check which instance holds your values, that is, whether your folders are under sourceanalytix.0 or under sourceanalytix.1.
2. On the "Instances" tab, delete the extra instance with the trash icon.

CAUTION

Deleting an instance also removes its folders with all values. Never delete the instance that holds your data. If you only want to retire a single source, use the "Deactivate" action on that source.

See also: Disable a datapoint or remove sources