Write adapter code

For network communication the adapter relies on the axios module, let's add it. In adapter dir run this:

npm install --save-prod axios

Additionally, we need to import axios in main.js or main.ts as follows. Please add the line at the top of the main file (there should already be a line containing the require function there, best is to keep all imports in one place).

JavaScriptTypeScript

const axios = require("axios").default;

import axios from 'axios';

Now have a look at the boilerplate and example code in main.js or main.ts. You should see a Class with a constructor where eventHandlers are added to ready, stateChange and unload by default. These are the functions that ioBroker will call in your code. First we will implement to download some data from the API in onReady after the adapter start.

You should read the examples in the onReady function that already explain how the adapter interacts with ioBroker in a lot of common examples. Feel free to try different things here, too. If you create objects and set states you can see the results of your actions in the dev-server admin.

Now let's retrieve some data in the onReady function. Replace the existing code with this:

JavaScriptTypeScript

async onReady() {
    axios.defaults.timeout = 5000; //set timeout to 5 seconds
    //download data:
    const url = 'https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/de.wikipedia/all-access/all-agents/IoBroker/daily/20220401/20220404';
    try {
        const response = await axios.get(url);
        if (response.status === 200) {
            const data = response.data;

            //for each day:
            for (const day of data.items) {
                //create object, using timestamp as ID. ID should always be unique and constant for a certain device.
                await this.setObjectNotExistsAsync(day.timestamp, {
                    type: 'state',
                    common: {
                        type: 'number',
                        role: 'value', //select a role from https://www.iobroker.net/#en/documentation/dev/stateroles.md - try to be as specific as possible.
                        read: true,
                        write: false,
                        name: `Day ${day.timestamp}`
                    },
                    native: {}
                });

                //now set the value of the state. Set 'ack' to true in order to show ioBroker that this data comes from the 'device'.
                await this.setStateAsync(day.timestamp, day.views, true);
            }
        } else {
            this.log.error('Could not retrieve data, status code ' + response.status);
        }
    } catch (e) {
        this.log.error('Could not retrieve data: ' + e.message);
    }
}

private async onReady(): Promise<void> { 
    axios.defaults.timeout = 5000; //set timeout to 5 seconds
    //download data:
    const url = 'https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/de.wikipedia/all-access/all-agents/IoBroker/daily/20220401/20220404';
    try {
        const response = await axios.get(url);
        if (response.status === 200) {
            const data = response.data;

            //for each day:
            for (const day of data.items) {
                //create object, using timestamp as ID. ID should always be unique and constant for a certain device.
                await this.setObjectNotExistsAsync(day.timestamp, {
                    type: 'state',
                    common: {
                        type: 'number',
                        role: 'value', //select a role from https://www.iobroker.net/#en/documentation/dev/stateroles.md - try to be as specific as possible.
                        read: true,
                        write: false,
                        name: `Day ${day.timestamp}`
                    },
                    native: {}
                });

                //now set the value of the state. Set 'ack' to true in order to show ioBroker that this data comes from the 'device'.
                await this.setStateAsync(day.timestamp, day.views, true);
            }
        } else {
            this.log.error('Could not retrieve data, status code ' + response.status);
        }
    } catch (e: any) {
        this.log.error('Could not retrieve data: ' + e.message);
    }
}

Regarding the role property of the state: Select a role from this list. Try to be as specific as possible. If you think a role is missing, feel free to create a pull request and propose a change for this file. Using the right role here will allow other adapers in the ioBroker ecosystem to understand what your state is about and control it.

If you have dev-server watch running as explained earlier this should already create a few objects with values in ioBroker on file save. But currently this is very static code. Let's allow the user to select a date.

We start by defining the parameters for our adapter in io-package.json, change the native section to this:

},<

JSON UI allows us to easily add an options page in ioBroker.admin