# Disclaimer: Data Collection

We are collecting some data to ensure an optimal experience going forward. The following sections explain which information we collect and why.

> [!NOTE] We do not store any data which can be used to identify users. Furthermore, we do not share the raw data with third parties.

## Crash reports

We use [Sentry](https://sentry.io) for automatic crash reporting. We self-host our sentry instance in Germany to ensure that we have control over the data. The transmitted reports include the following data:

-   `zwave-js` version
-   A fingerprint which is **randomly generated** during the installation. This is used to gauge how many users an issue affects (and to quickly ignore crashes caused by devs who are just messing around).
-   A Node.js stacktrace including an error message and the function calls which lead to the error.

## Device telemetry

We also use [Sentry](https://sentry.io) to capture basic information about devices that were successfully interviewed but have no config file. These often have suboptimal labels that we can improve on (or no information at all). The reports include the following data:

-   Whether the device supports `Configuration CC V3+` - if yes, the discovered metadata for the config parameters is recorded
-   Whether the device supports `Association Group Information CC` - if yes, the discovered association group labels are recorded
-   Whether the device supports `Z-Wave Plus` and if yes, which version of the standard it implements
-   A fingerprint which is **randomly generated** during the installation. This is used to gauge how many users have this device.

## Usage statistics

In order to gain insight into how `zwave-js` is used, which manufacturers and devices are most prevalent and where to best focus our efforts in order to improve `zwave-js` the most, we collect statistics about the devices used in our ecosystem. This information is only collected **if the application developer has opted in** into this functionality. Since some users may have concerns about this data being collected, even though the data cannot be tied to a specific user, we have built our own [statistics stack](https://github.com/zwave-js/statistics-server) which is self-hosted next to the Sentry instances. The reports include the following data:

-   A **hash** of your network's home ID salted with a 32 byte randomly generated number. This is used to distinguish the individual records to ensure that duplicate entries aren't made. The hash cannot be reversed to reconstruct the home ID without knowing the salt which is not collected.
-   The application that uses `zwave-js` and its version.
-   The version of `zwave-js`.
-   The version of `Node.js` and your operating system **platform** and **architecture**.
-   The **manufacturer ID**, **product type**, **product ID** and **firmware version** that are reported by each device - in other words which devices you have.

> [!NOTE] We do not collect your IP address, nor is the IP address or any other identifying information stored and tied to a record.

Here's an example of the collected data along with an explanation:

```json
{
	"id": "abcde...0192", // The hash of the salted network's home id
	"driverVersion": "7.1.0", // Which version of zwave-js you're running
	"applicationName": "ioBroker.zwave2", // The application's name, provided by the application
	"applicationVersion": "1.9.1", // The version of the application you're using
	"nodeVersion": "16.3.0", // The version of Node.js which is executing the application
	"os": "linux",
	"arch": "x64",
	"devices": [
		{
			// Aeotec MultiSensor 6 (ZW100):
			"manufacturerId": "0x0086",
			"productType": "0x0002",
			"productId": "0x0064",
			"firmwareVersion": "1.9"
		}
		// ... other devices
	]
}
```

Application developers may choose to enable this functionality after displaying a notice to the user in either an opt-in or opt-out fashion. Whichever is chosen, developers are expected to inform users of this collection and to provide some mechanism for users to disable collection. A short description of the importance of collecting this data to the project is included at [User Disclosure](data-collection/user-disclosure.md).