diff --git a/docs/rewards/reward-boosts.mdx b/docs/rewards/reward-boosts.mdx index 1dcbb503..78459b39 100644 --- a/docs/rewards/reward-boosts.mdx +++ b/docs/rewards/reward-boosts.mdx @@ -89,7 +89,7 @@ Any currently open cell bounties may be viewed in [WeatherXM Explorer](https://e ::: Stations which are deployed at bounty cells within the announced participation period will be eligible to receive extra rewards. Each bounty defines a maximum number of stations -which may share the rewards. Should the number of eligible bounty stations exceed the bounty capacity, a ranking based on [QoD scores](/weather-and-science/quality-mechanisms/general-qod-description.mdx) and seniority is used +which may share the rewards. Should the number of eligible bounty stations exceed the bounty capacity, a ranking based on [QoD scores](/weather-and-science/quality-mechanisms/general-qod-description) and seniority is used to distribute rewards fairly. **Stations must meet a minimum of 0.8 QoD score to receive rewards**. ## Examples of reward programs that may be implemented using **Rewards Boost**, in the near future are: diff --git a/docs/weather-and-science/quality-mechanisms/general-qod-description.mdx b/docs/weather-and-science/quality-mechanisms/general-qod-description.mdx index 6dad358e..52bf596d 100644 --- a/docs/weather-and-science/quality-mechanisms/general-qod-description.mdx +++ b/docs/weather-and-science/quality-mechanisms/general-qod-description.mdx @@ -2,7 +2,7 @@ id: general-qod-description title: General QoD Description (OBC-SQC, ISD, SPV) sidebar_label: General QoD Description (OBC-SQC, ISD, SPV) -slug: /weather-and-science/quality-mechanisms/general-qod-description.mdx +slug: /weather-and-science/quality-mechanisms/general-qod-description --- # General QoD Description (OBC-SQC, ISD, SPV) @@ -37,7 +37,7 @@ The checks performed are: - **Check for suspicious spikes** over short time intervals, which may occur either due to poor station placement or because of a faulty sensor. For example, a temperature change >3°C within 1 minute is considered unrealistic. If the station’s sampling interval is greater than 1 minute, the respective threshold is increased linearly, provided that the sampling rate remains below 10 minutes. - **Check for gaps in the data**. Each station model, according to its specifications, is capable of sending data packets at a specific time interval. If the number of packets received on an hourly basis is lower than the threshold set by the specifications, this indicates a problem in data transmission (e.g., poor 4G/Wi-Fi/Helium signal). -Similar checks (for stagnation and spikes), but with different time windows (based on WMO –[Guide to the Global Observing System (WMO-No. 488), pg.200](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)– guidelines as well as our [own data analysis](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)), are carried out for all parameters (see [full documentation](/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx)). +Similar checks (for stagnation and spikes), but with different time windows (based on WMO –[Guide to the Global Observing System (WMO-No. 488), pg.200](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)– guidelines as well as our [own data analysis](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)), are carried out for all parameters (see [full documentation](/weather-and-science/quality-mechanisms/obc-sqc-documentation)). Finally, the ratio of invalid to expected valid data is calculated on an hourly basis in order to determine the final score of successful meteorological observations. @@ -46,7 +46,7 @@ Finally, the ratio of invalid to expected valid data is calculated on an hourly The ISD is a mechanism primarily aimed at identifying stations that are active but have not been placed outdoors. However, there is a range of other classifications that can be assigned to a station’s deployment status. The ISD mechanism runs once per day and evaluates the data from the entire previous day, but for the final evaluation result it also takes into account the outcomes from the last seven days in order to provide a fairer classification of the station’s deployment. The key difference compared to OBC-SQC is that ISD evaluates the entire day as a whole, assigning a single annotation related to the station’s deployment status. -For deployment assessment, the ISD uses solar radiation analysis techniques, comparing actual measurements with theoretical radiation values for each location on the planet and for each day of the year. In parallel, various combined thresholds are applied to temperature, wind direction/speed, and relative humidity (thresholds derived from exploratory data analysis) in order to identify certain significantly problematic deployment cases. It should be noted, however, that ISD is able to detect only a small subset of problematic deployments, as its main focus is on identifying stations that are located indoors. The classifications resulting from the ISD mechanism are shown in Table 1. See full [ISD documentation here](/weather-and-science/quality-mechanisms/isd-full-documentation.mdx). +For deployment assessment, the ISD uses solar radiation analysis techniques, comparing actual measurements with theoretical radiation values for each location on the planet and for each day of the year. In parallel, various combined thresholds are applied to temperature, wind direction/speed, and relative humidity (thresholds derived from exploratory data analysis) in order to identify certain significantly problematic deployment cases. It should be noted, however, that ISD is able to detect only a small subset of problematic deployments, as its main focus is on identifying stations that are located indoors. The classifications resulting from the ISD mechanism are shown in Table 1. See full [ISD documentation here](/weather-and-science/quality-mechanisms/isd-full-documentation). Table 1. ISD annotations, their short description, and their impact on the quality score. Note that the short description is statistically derived, and the actual status of the station may differ. @@ -74,7 +74,7 @@ Note that the short description is statistically derived, and the actual status ## Station Photo Verification (SPV) -At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO) (see also [our obstacle experiment](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx)). The SPV mechanism evaluates the deployment of each station as depicted in the photos submitted by the user through the mobile app. Through SPV, seven key aspects of the photos are examined in order to assess both the overall deployment and the extent to which each parameter can be measured accurately. This mechanism assigns a score to the station each time the user submits a set of photos, which is then evaluated internally by company staff. The 7 aspects and how they affect the SPV score are described in Table 2. Each aspect is assessed separately based on the condition shown in the photo under evaluation, unless an issue is identified that affects the station’s measurements regardless of orientation. Each photo receives a score for each of the 5 aspects that can be scored, and then the average score per photo is calculated. Finally, the average score of the 4 photos (one for each cardinal direction) is computed, which determines the final SPV score. It should be noted that if there is no photo for a specific cardinal direction, the score for that direction is considered to be zero. The SPV scoring rules and guidelines are comprehensively described in [this document](/weather-and-science/quality-mechanisms/spv-full-documentation.mdx). +At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO) (see also [our obstacle experiment](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx)). The SPV mechanism evaluates the deployment of each station as depicted in the photos submitted by the user through the mobile app. Through SPV, seven key aspects of the photos are examined in order to assess both the overall deployment and the extent to which each parameter can be measured accurately. This mechanism assigns a score to the station each time the user submits a set of photos, which is then evaluated internally by company staff. The 7 aspects and how they affect the SPV score are described in Table 2. Each aspect is assessed separately based on the condition shown in the photo under evaluation, unless an issue is identified that affects the station’s measurements regardless of orientation. Each photo receives a score for each of the 5 aspects that can be scored, and then the average score per photo is calculated. Finally, the average score of the 4 photos (one for each cardinal direction) is computed, which determines the final SPV score. It should be noted that if there is no photo for a specific cardinal direction, the score for that direction is considered to be zero. The SPV scoring rules and guidelines are comprehensively described in [this document](/weather-and-science/quality-mechanisms/spv-full-documentation). Table 2. The SPV aspects, their short description and the available score options. diff --git a/docs/weather-and-science/quality-mechanisms/index.mdx b/docs/weather-and-science/quality-mechanisms/index.mdx index 895cd942..ddef6cb8 100644 --- a/docs/weather-and-science/quality-mechanisms/index.mdx +++ b/docs/weather-and-science/quality-mechanisms/index.mdx @@ -10,9 +10,9 @@ In this section, all the available quality mechanisms are fully described. ## Contents -- [**General QoD Description (OBC-SQC, ISD, SPV)**](/weather-and-science/quality-mechanisms/general-qod-description.mdx): General and brief description of all the available quality mechanisms. -- [**Indoors Station Detector (ISD)**](/weather-and-science/quality-mechanisms/isd-full-documentation.mdx): Full documentation of the Indoors Station Detector (ISD), which is the mechanism that detects stations placed indoors, but also some other problematic situations. -- [**OBC and SQC Annotations**](/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx): Description of the annotations produced by the OBC-SQC quality mechanism. -- [**Out-of-Bounds (OBC) and Self Quality Checks (SQC)**](/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx): Full documentation of the Out-of-Bounds Check (OBC) and Self-Quality-Check (SQC) mechanism, which focuses on the detection of suspicious data in the transmitted raw data. -- [**OBC and SQC Score Calculation**](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx): The method of the final daily OBC-SQC score calculation. -- [**Station Photo Verification (SPV)**](/weather-and-science/quality-mechanisms/spv-full-documentation.mdx): Full documentation of the Station Photo Verification (SPV) mechanism, which aims to evaluate the station deployments via photos. \ No newline at end of file +- [**General QoD Description (OBC-SQC, ISD, SPV)**](/weather-and-science/quality-mechanisms/general-qod-description): General and brief description of all the available quality mechanisms. +- [**Indoors Station Detector (ISD)**](/weather-and-science/quality-mechanisms/isd-full-documentation): Full documentation of the Indoors Station Detector (ISD), which is the mechanism that detects stations placed indoors, but also some other problematic situations. +- [**OBC and SQC Annotations**](/weather-and-science/quality-mechanisms/obc-sqc-annotations): Description of the annotations produced by the OBC-SQC quality mechanism. +- [**Out-of-Bounds (OBC) and Self Quality Checks (SQC)**](/weather-and-science/quality-mechanisms/obc-sqc-documentation): Full documentation of the Out-of-Bounds Check (OBC) and Self-Quality-Check (SQC) mechanism, which focuses on the detection of suspicious data in the transmitted raw data. +- [**OBC and SQC Score Calculation**](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation): The method of the final daily OBC-SQC score calculation. +- [**Station Photo Verification (SPV)**](/weather-and-science/quality-mechanisms/spv-full-documentation): Full documentation of the Station Photo Verification (SPV) mechanism, which aims to evaluate the station deployments via photos. \ No newline at end of file diff --git a/docs/weather-and-science/quality-mechanisms/isd-full-documentation.mdx b/docs/weather-and-science/quality-mechanisms/isd-full-documentation.mdx index 290c059b..f0e14497 100644 --- a/docs/weather-and-science/quality-mechanisms/isd-full-documentation.mdx +++ b/docs/weather-and-science/quality-mechanisms/isd-full-documentation.mdx @@ -2,7 +2,7 @@ id: isd-full-documentation title: Indoors Station Detector (ISD) sidebar_label: Indoors Station Detector (ISD) -slug: /weather-and-science/quality-mechanisms/isd-full-documentation.mdx +slug: /weather-and-science/quality-mechanisms/isd-full-documentation --- # Indoor Station Detector (ISD) diff --git a/docs/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx b/docs/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx index 6f8ec850..d968388f 100644 --- a/docs/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx +++ b/docs/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx @@ -2,7 +2,7 @@ id: obc-sqc-annotations title: OBC and SQC Annotations sidebar_label: OBC and SQC Annotations -slug: /weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx +slug: /weather-and-science/quality-mechanisms/obc-sqc-annotations --- # Out-of-Bounds (OBC) and Self Quality Checks (SQC) Annotations diff --git a/docs/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx b/docs/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx index da0bb4af..956d03ff 100644 --- a/docs/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx +++ b/docs/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx @@ -2,7 +2,7 @@ id: obc-sqc-documentation title: Out-of-Bounds (OBC) and Self Quality Checks (SQC) sidebar_label: Out-of-Bounds (OBC) and Self Quality Checks (SQC) -slug: /weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx +slug: /weather-and-science/quality-mechanisms/obc-sqc-documentation --- # Obstacle Impact on Temperature and Wind @@ -18,7 +18,7 @@ Data Quality v1 is able to process: - Time series with an interval <30 seconds (High Temporal Resolution Time series - **HTRT**) - Time series with a time interval ≥1 minute (Low Temporal Resolution Time series - **LTRT**). We consider that the value provided on this time interval (e.g., 3 minutes) time interval is the outcome derived from the averaging of a sequence of internally recorded measurements. -The **final output of the Data Quality mechanism** is an hourly **percentage** of valid/available data and the corresponding **text annotations per meteorological variable** (temperature, relative humidity, wind speed, wind direction, atmospheric pressure, illuminance and precipitation). However, there is a [post Data Quality score process](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx) that aggregates all the annotations and scores into a daily output per station. +The **final output of the Data Quality mechanism** is an hourly **percentage** of valid/available data and the corresponding **text annotations per meteorological variable** (temperature, relative humidity, wind speed, wind direction, atmospheric pressure, illuminance and precipitation). However, there is a [post Data Quality score process](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation) that aggregates all the annotations and scores into a daily output per station. Before moving forward to the description of the Data Quality mechanism, we should note that the input data has been standardised over time (resampling). Weather stations may transmit data at varying non-fixed time intervals. This implies that even if a station's specification indicates a recording frequency of 16 seconds, the actual interval can fluctuate, ranging from a few seconds to several minutes. To ensure that the quality control operates on a time-normalised dataset, a new timeframe is established with a fixed interval (determined by the theoretical recording frequency (fr) of the station model, such as 16’’ for the WG1000 - M5 model). diff --git a/docs/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx b/docs/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx index d8dec0ac..9dd73bc0 100644 --- a/docs/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx +++ b/docs/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx @@ -2,7 +2,7 @@ id: obc-sqc-score-calculation title: OBC and SQC Score Calculation sidebar_label: OBC and SQC Score Calculation -slug: /weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx +slug: /weather-and-science/quality-mechanisms/obc-sqc-score-calculation --- # Out-of-Bounds (OBC) and Self Quality Checks (SQC) Score Calculation diff --git a/docs/weather-and-science/quality-mechanisms/spv-full-documentation.mdx b/docs/weather-and-science/quality-mechanisms/spv-full-documentation.mdx index 035471a4..4673217d 100644 --- a/docs/weather-and-science/quality-mechanisms/spv-full-documentation.mdx +++ b/docs/weather-and-science/quality-mechanisms/spv-full-documentation.mdx @@ -2,7 +2,7 @@ id: spv-full-documentation title: Station Photo Verification (SPV) sidebar_label: Station Photo Verification (SPV) -slug: /weather-and-science/quality-mechanisms/spv-full-documentation.mdx +slug: /weather-and-science/quality-mechanisms/spv-full-documentation --- #Station Photo Verification (SPV) Full Documentation diff --git a/docs/weather-and-science/r&d/sqc-constancy-analysis-report.mdx b/docs/weather-and-science/r&d/sqc-constancy-analysis-report.mdx index c58fb9c2..ebfaa851 100644 --- a/docs/weather-and-science/r&d/sqc-constancy-analysis-report.mdx +++ b/docs/weather-and-science/r&d/sqc-constancy-analysis-report.mdx @@ -2,7 +2,7 @@ id: constancy-analysis-report title: SQC - Constancy Analysis Report sidebar_label: SQC - Constancy Analysis Report -slug: /weather-and-science/quality-mechanisms/constancy-analysis-report.mdx +slug: /weather-and-science/quality-mechanisms/constancy-analysis-report --- # Constancy Analysis Report @@ -27,7 +27,7 @@ To ensure that we tailor these criteria to match the specifications of WeatherXM -The datasets were averaged over 1 minute intervals, which corresponds to the "ignoring period" (during which we populate empty rows with data to facilitate Quality of Data processes - see [QoD documentation section 1](/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx#1-filling-ignoring-period---filling-no-data-slots)) chosen in the Quality of Data (QoD) mechanism. Then, we determined the duration of time during which consecutive observations remained at a certain value. +The datasets were averaged over 1 minute intervals, which corresponds to the "ignoring period" (during which we populate empty rows with data to facilitate Quality of Data processes - see [QoD documentation section 1](/weather-and-science/quality-mechanisms/obc-sqc-documentation#1-filling-ignoring-period---filling-no-data-slots)) chosen in the Quality of Data (QoD) mechanism. Then, we determined the duration of time during which consecutive observations remained at a certain value. ## 2. results diff --git a/docs/weather-and-science/r&d/weatherxm-vs-wmo-compliant.mdx b/docs/weather-and-science/r&d/weatherxm-vs-wmo-compliant.mdx index 02b952dd..d8eeb2ee 100644 --- a/docs/weather-and-science/r&d/weatherxm-vs-wmo-compliant.mdx +++ b/docs/weather-and-science/r&d/weatherxm-vs-wmo-compliant.mdx @@ -8,7 +8,7 @@ slug: /weather-and-science/weatherxm-vs-wmo-compliant Dr. Stavros Keppas, 30/10/23 - WeatherXM AG ## 1. Introduction -In the pursuit of high-quality meteorological data, we aim to identify potential systematic errors and failures that the various WeatherXM station models may exhibit. For this reason, in the present study we compare impeccably installed WeatherXM weather stations, as assessed by the [SPV](https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation.mdx) mechanism (and the installation photos), with nearby meteorological stations that provide data via SYNOP. +In the pursuit of high-quality meteorological data, we aim to identify potential systematic errors and failures that the various WeatherXM station models may exhibit. For this reason, in the present study we compare impeccably installed WeatherXM weather stations, as assessed by the [SPV](https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation) mechanism (and the installation photos), with nearby meteorological stations that provide data via SYNOP. ## 2. Data and Methods In general, there is an inconsistency between airport data and that from WeatherXM stations, mainly in terms of the temporal sampling interval, but also in the set of available parameters. diff --git a/docs/wxm-devices/deployment-examples.mdx b/docs/wxm-devices/deployment-examples.mdx index 8dd9a8fc..479f9876 100644 --- a/docs/wxm-devices/deployment-examples.mdx +++ b/docs/wxm-devices/deployment-examples.mdx @@ -1,17 +1,19 @@ --- -title: Deployment Examples -hide_title: true +title: Weather Station Deployment Examples +description: Real-world examples of good and problematic WeatherXM weather station installations, with guidance on mast height, obstacles, wind exposure, rain, temperature and solar radiation. sidebar_label: Deployment Examples --- import useBaseUrl from "@docusaurus/useBaseUrl"; +Use these real-world examples to evaluate where to install a WeatherXM station and how nearby roofs, walls, trees, fences and chimneys can affect measurements. For the best data quality, place the outdoor sensor as high and as clear of nearby obstacles as practical, following the installation guidance for your station model. + ## Good Installations ### Case 1
- + WeatherXM station installed high above an apartment roof on a tall mast

The station has been deployed at the highest point of this apartment, which is located at an area, where buildings present similar heights. Thus, the outdoor sensor is over the level of any object around. It is also placed on a >2m mast and, hence, temperature/humidity is not affected by the roof’s material.

@@ -23,8 +25,8 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
- - + WeatherXM station on a rooftop with a clear horizon and nearby trees below sensor level + Second view of a rooftop WeatherXM station with mostly unobstructed exposure

@@ -38,7 +40,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ### Case 3

- + WeatherXM station on a very tall mast above a roof and sparse palm trees

The station has been deployed at the highest point of this apartment, which is located at an area, where other obstacles are not much higher. In addition, the mast is ~7m makes the deployment quite ideal. Sparse thin coconut trees shouldn’t be able to affect measurements. In a case like that the user should tight firmly the wires that stabilise the mast. Otherwise, the mast may significantly oscillate, producing faulty wind and especially rain measurements.

@@ -50,8 +52,8 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
- - + WeatherXM station on a 2.5 metre mast in an open area with a clear horizon + Second view of an open WeatherXM station deployment with a distant house

@@ -69,8 +71,8 @@ import useBaseUrl from "@docusaurus/useBaseUrl";

- - + WeatherXM station mounted near a fence, bush and surrounding buildings + Second view of a WeatherXM station with nearby fence and vegetation obstacles

@@ -94,12 +96,12 @@ The station should be moved to the terrace of the house (which is not visible in

- - + East-facing view from a WeatherXM station surrounded by trees + North-facing view from a WeatherXM station surrounded by trees
- - + South-facing view from a WeatherXM station surrounded by trees + West-facing view and obstacle context for a WeatherXM station deployment

@@ -117,7 +119,7 @@ The trees at the west and south have a significant impact on wind speed/directio :::tip

- + Suggested nearby rooftop location for improving a WeatherXM station deployment

The station could ideally be moved to the roof of the nearby building (using a 3-4m-mast) in order to be placed as higher as possible to avoid at least the closest obstacles. Otherwise (if there is no other available place) a 5-7m-mast could be used at the same place in order to place the weather station above the level of the closer obstacles.

@@ -130,7 +132,7 @@ The trees at the west and south have a significant impact on wind speed/directio ### Case 7
- + WeatherXM station mounted only slightly above a wooden structure

The station is placed just a few tens of centimetres over a wooden structure. From this photo it is unknown if there are any obstacles at the north-east-south.

@@ -150,8 +152,8 @@ The outdoor sensor should be placed on a higher mast (at least a 2m one) over th
- - + WeatherXM rooftop station before raising the sensor farther above nearby obstacles + WeatherXM rooftop station after raising the sensor to improve exposure

@@ -178,7 +180,7 @@ The user moved the outdoor sensor higher by ~1m increasing the distance-height

- + WeatherXM station mounted beside and below the top of a chimney structure

@@ -201,7 +203,7 @@ In case that chimney is inactive, the outdoor sensor should be placed at the sam

- + WeatherXM station installed on a balcony close to a wall and roof

@@ -224,7 +226,7 @@ A balcony is not a place for a weather station. The station should be moved to t

- + WeatherXM station near a chimney with taller buildings and trees around it

diff --git a/package.json b/package.json index 6504ef8b..ee521445 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,8 @@ "deploy": "docusaurus deploy", "serve": "docusaurus serve", "spellcheck": "cspell \"docs/**\" --show-suggestions", - "spellcheck-on-pr": "cspell --no-must-find-files --file-list stdin" + "spellcheck-on-pr": "cspell --no-must-find-files --file-list stdin", + "prebuild": "node scripts/generate-llms.mjs" }, "dependencies": { "@docusaurus/core": "^3.9.2", diff --git a/redirects.js b/redirects.js index 61639f3c..1ad64a74 100644 --- a/redirects.js +++ b/redirects.js @@ -190,5 +190,33 @@ module.exports = [ { to: "/wxm-devices/m5/usb-flasher", from: "/wxm-devices/wifi-m5-bundle/m5-usb-flasher" + }, + { + to: "/weather-and-science/quality-mechanisms/general-qod-description", + from: "/weather-and-science/quality-mechanisms/general-qod-description.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/constancy-analysis-report", + from: "/weather-and-science/quality-mechanisms/constancy-analysis-report.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/obc-sqc-annotations", + from: "/weather-and-science/quality-mechanisms/obc-sqc-annotations.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/obc-sqc-documentation", + from: "/weather-and-science/quality-mechanisms/obc-sqc-documentation.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/isd-full-documentation", + from: "/weather-and-science/quality-mechanisms/isd-full-documentation.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/spv-full-documentation", + from: "/weather-and-science/quality-mechanisms/spv-full-documentation.mdx" + }, + { + to: "/weather-and-science/quality-mechanisms/obc-sqc-score-calculation", + from: "/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.mdx" } ] diff --git a/scripts/generate-llms.mjs b/scripts/generate-llms.mjs new file mode 100644 index 00000000..fdc9a72e --- /dev/null +++ b/scripts/generate-llms.mjs @@ -0,0 +1,130 @@ +import fs from "node:fs"; +import path from "node:path"; + +const docsDir = "docs"; +const staticDir = "static"; +const mirrorDir = path.join(staticDir, "llms-pages"); + +fs.rmSync(mirrorDir, { recursive: true, force: true }); +fs.mkdirSync(mirrorDir, { recursive: true }); + +const walk = (dir) => fs.readdirSync(dir, { withFileTypes: true }).flatMap((entry) => { + const p = path.join(dir, entry.name); + return entry.isDirectory() ? walk(p) : [p]; +}); + +const parseFrontmatter = (source) => { + if (!source.startsWith("---\n")) return { fm: {}, body: source }; + const end = source.indexOf("\n---\n", 4); + if (end === -1) return { fm: {}, body: source }; + const raw = source.slice(4, end); + const fm = {}; + for (const line of raw.split("\n")) { + const m = line.match(/^([A-Za-z0-9_-]+):\s*(.*)$/); + if (m) fm[m[1]] = m[2].replace(/^["']|["']$/g, ""); + } + return { fm, body: source.slice(end + 5) }; +}; + +const cleanBody = (body) => body + .replace(/^import\s+.*;\s*$/gm, "") + .replace(/]*\balt=["']([^"']+)["'][^>]*\/?\s*>/gi, "![$1](image)") + .replace(/]*\/?\s*>/gi, "") + .replace(/<\/?(?:div|span|figure|figcaption|p|table|thead|tbody|tr|td|th)[^>]*>/gi, "") + .replace(/\n{3,}/g, "\n\n") + .trim(); + +const routeFor = (file, fm) => { + if (fm.slug) return fm.slug; + let rel = path.relative(docsDir, file).replace(/\\/g, "/").replace(/\.(md|mdx)$/i, ""); + if (rel === "home") return "/"; + if (rel.endsWith("/index")) rel = rel.slice(0, -6); + return "/" + rel; +}; + +const files = walk(docsDir).filter((p) => /\.(md|mdx)$/i.test(p)); +const pages = []; + +for (const file of files) { + const source = fs.readFileSync(file, "utf8"); + const { fm, body } = parseFrontmatter(source); + const route = routeFor(file, fm); + const title = fm.title || route.split("/").filter(Boolean).pop() || "WeatherXM Docs"; + const description = fm.description || ""; + const clean = cleanBody(body); + const mirror = (route === "/" ? "index" : route.replace(/^\//, "").replace(/\/$/, "")) + ".md"; + const mirrorPath = path.join(mirrorDir, mirror); + fs.mkdirSync(path.dirname(mirrorPath), { recursive: true }); + fs.writeFileSync( + mirrorPath, + `# ${title}\n\nCanonical: https://docs.weatherxm.com${route}\n\n${description ? description + "\n\n" : ""}${clean}\n` + ); + pages.push({ route, title, description, mirror: "/llms-pages/" + mirror.replace(/\\/g, "/"), clean }); +} + +pages.sort((a, b) => a.route.localeCompare(b.route)); + +const keyRoutes = new Set([ + "/", + "/introduction", + "/wxm-devices/deployment-examples", + "/wxm-devices/d1/introduction", + "/wxm-devices/helium/introduction", + "/wxm-devices/pulse/introduction", + "/weather-and-science", + "/weather-and-science/quality-mechanisms/general-qod-description", + "/weatherxm-pro", + "/faq", + "/glossary" +]); + +const keyPages = pages.filter((p) => keyRoutes.has(p.route)); +const llms = [ + "# WeatherXM Documentation", + "", + "> Technical documentation for WeatherXM weather stations, deployment, data quality, rewards, WeatherXM Pro and weather science.", + "", + "## Canonical resources", + "- Main WeatherXM site: https://weatherxm.com/", + "- Weather station catalog: https://weatherxm.com/stations/", + "- Data & forecasts: https://weatherxm.com/data/", + "- Open technology: https://weatherxm.com/open/", + "- Firmware flasher: https://flasher.weatherxm.com/", + "- Network Association: https://weatherxm.network/", + "- GitHub: https://github.com/WeatherXM", + "", + "## Key documentation", + ...keyPages.flatMap((p) => [ + `- ${p.title}: https://docs.weatherxm.com${p.route}`, + ` - Markdown: https://docs.weatherxm.com${p.mirror}` + ]), + "", + "## Full corpus", + "- Combined text corpus: https://docs.weatherxm.com/llms-full.txt", + "- Individual Markdown mirrors are under https://docs.weatherxm.com/llms-pages/", + "", + "Use the canonical HTML URL when citing a page. Use the Markdown mirror when a text-only representation is easier to process.", + "" +].join("\n"); + +fs.writeFileSync(path.join(staticDir, "llms.txt"), llms); + +const full = [ + "# WeatherXM Documentation — full text corpus", + "", + "Canonical site: https://docs.weatherxm.com/", + "Generated from the public WeatherXM documentation source at build time.", + "", + ...pages.flatMap((p) => [ + "---", + `# ${p.title}`, + `Canonical: https://docs.weatherxm.com${p.route}`, + `Markdown: https://docs.weatherxm.com${p.mirror}`, + "", + p.clean, + "" + ]) +].join("\n"); + +fs.writeFileSync(path.join(staticDir, "llms-full.txt"), full); +console.log(`Generated LLM discovery files for ${pages.length} docs pages`); diff --git a/static/llms-full.txt b/static/llms-full.txt new file mode 100644 index 00000000..4a937a3b --- /dev/null +++ b/static/llms-full.txt @@ -0,0 +1,8081 @@ +# WeatherXM Documentation — full text corpus + +Canonical site: https://docs.weatherxm.com/ +Generated from the public WeatherXM documentation source at build time. + +--- +# Homepage +Canonical: https://docs.weatherxm.com/ +Markdown: https://docs.weatherxm.com/llms-pages/index.md + +## Welcome aboard + +WeatherXM is a community-powered weather network that rewards weather station owners and provides accurate weather services to Web3 enterprises. +WeatherXM weather stations are the world’s first to natively support Web3 technologies. + +

+ + + + +

WeatherXM M5 bundle (WB1000)

+ This is our developer friendly, local weather data miner bundled with an easy to set up all-in-one weather station. + + + + + + + +

WeatherXM Helium station (WS2000)

+ Compatible all-in-one weather station. Connects to Helium network and submits weather data to WeatherXM. + + + +
+ +
+ + + + +

WeatherXM D1 bundle (WB1200)

+ The WB1200 is a bundle product that combines the WS1001 weather station with our open source WeatherXM WG1200 Gateway. + + + + + + + +

WeatherXM Pulse bundle (WB3000)

+ The WB3000 is a bundle product, that combines the WS1001 weather station with our WG3000 Gateway which uses 4G - LTE. + + + +
+ +

WeatherXM Project

+ +WeatherXM creates an entirely new weather data economy that rewards people who deploy and maintain weather stations. + +They are all-in-one, easy to deploy, energy and communication autonomous, and designed for large-scale deployment. +WeatherXM makes weather-related smart contracts on-chain a reality. + +This documentation site attempts to explain various aspects of the WeatherXM project. + +

Thank you for supporting WeatherXM!

+
Quick Links
+ +• The $WXM Token +

+• WeatherXM Pro +

+• Reward Mechanism +

+• Data Quality +

+• Proof of Location (PoL) +



+Join our Discord Community Server. + +--- +# Help Center / FAQ +Canonical: https://docs.weatherxm.com/faq +Markdown: https://docs.weatherxm.com/llms-pages/faq.md + +:::tip +Remember that you always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. +::: + +## Data + +### Is there a chance for my host/friend to be able to have access to my station's data? + +Yes! It was a common feature request so we have implemented it. You can share your station's data with your friends by using the share button on the station's page on the [explorer](https://explorer.weatherxm.com/). Also, you can "favourite" any station you like by clicking on the heart shaped button while using our mobile App. +The station will appear in your station list. + +
+ +### How do you know people are not faking the location of their station on the map? + +In addition to the cryptographic proofs from all station data sent to the WeatherXM Network, we have designed and implemented a unique Proof of Location algorithm to safeguard the accuracy of the weather station location. Read more at the [PoL section of the documentation](/rewards/proof-of-location). + +## Hardware + +### Can I connect my WXM station with a 3rd party station? + +Our weather stations are custom built, they are developed to connect to our network with our firmware and software implementations. The SDR receiver is no longer on our roadmap. + +
+ +### What are the differences between the WG1000 gateway station and the WXM Helium compatible station? + +1. The WeatherXM Helium station has an integrated (located within the weather station) Helium-compatible LoRaWAN chip, crypto chip, and GPS while the Wi-Fi bundle has a Wi-Fi gateway, crypto chip, and GPS located within the external WG1000 gateway. +1. WeatherXM Helium station can only connect to the Helium Network while the Wi-Fi bundle can only connect to Wi-Fi. +1. The WeatherXM helium weather station has a larger solar panel which allows it to do processing standalone (in the station itself) while the Wi-Fi bundle's station has a smaller solar panel since the processing is done by the external WG1000 display and Wi-Fi gateway (located indoors) which the station communicates to over RF. +1. The WeatherXM Helium bundle does not contain any type of display to view weather data. Weather data will have to be viewed from the WeatherXM app. + +
+ +### Can I connect my WeatherXM Helium compatible station to any Helium around or should I request access from someone? + +You can connect your WeatherXM Helium compatible station anywhere with Helium network coverage or near a Helium gateway. The gateway that will handle your packet is usually the fastest to respond but this is influenced by numerous factors. This means that the closest Helium gateway will not necessarily be the one that will pick up your packet, nor you can choose or influence this. + +
+ +### Will it make a big difference if I place my station on the balcony instead of the roof? + +It is mandatory that you place your station on the roof and the reason is because there aren't so many obstacles as there are on a balcony (e.g walls), that will reduce the quality of your data, therefore the amount of your rewards. +You can also check the [deployment examples](/wxm-devices/deployment-examples) for inspiration. + +
+ +### Is any of your stations suitable for very cold climates? + +For very cold climates that have snow most of the year, we will be launching soon a special weather station with a heater suitable for these weather conditions. + +
+ +### Which is the recommended frequency for my country? + +You can refer to the mapping table that provides detailed information on the frequency allocations per country by visiting the [frequencies plans](/wxm-devices/frequency-plans) page. + +## Rewards + +### How can I start receiving rewards? + +If you have already set up your station and claimed your device via the app, please add Metamask and follow the instructions [here](/mobile-app/wallet/add-edit-wallet-address) and then follow this guide to [claim your rewards](/rewards/rewards-claiming). + +
+ +### How can I check my rewards? + +You can check your rewards by using our mobile App and follow this guide to [claim your rewards](/rewards/rewards-claiming). + +
+ +### Do I have to pay for the HNT/DC fees? + +We are covering the HNT/DC fees. + +
+ +### Can I change my wallet address in the future? + +You can change your wallet address in the future. Just so you know, rewards are allocated daily per your wallet, if you change wallet in the future then the rewards up to that moment are allocated to your previous wallet. +Unclaimed rewards cannot be transferred to a new wallet and can only be claimed by the connected wallet address at the time of rewards allocation. + +
+ +### How many stations are allowed in a Hex? + +Such details will be defined in by the [WeatherXM Network](https://weatherxm.network/). + +
+ +## Sales + +### Can I receive my invoice before my order ships? + +You will receive your invoice and receipt when your order ships. If you need an invoice earlier you can contact us through [support](https://support.weatherxm.com). + +
+ +### When will my order ship? + +We are improving our logistic methods and you will receive your order in 1-2 weeks. + +
+ +### Can I change my shipping address? + +As long as your order hasn't shipped you can contact us through [support](https://support.weatherxm.com) and we will change it for you. + +
+ +### Can I request a refund? + +You can request a refund by sending us a message through [support](https://support.weatherxm.com) and we will refund you according to our [refund policy](https://weatherxm.com/terms-conditions/). + +
+ +### Can I cancel my order if it has already been shipped? + +You can not cancel it if it has already been shipped but you can deny the delivery when it reaches to your door and we will refund you according to our [refund policy](https://weatherxm.com/terms-conditions/). + +
+ +### Where do you ship the devices from? + +We ship from China and then the devices are distributed to our warehouses in US/CA/UK/EU. + +
+ +### How can I purchase more than 2 weather stations? + +You can complete our [bulk sales](https://pages.weatherxm.com/bulk-order-form) form and we will contact you as soon as possible. + +
+ +### How much time does it take for the refund to reflect to my bank account? + +Note that refunds take 3-15 working days to reflect on your bank account. +If it hasn't been reflected in your bank account after 15 days you should contact us by sending a message through [support](https://support.weatherxm.com) + +
+ +:::tip +Remember that you always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. +::: + +--- +# Glossary of Common Terms +Canonical: https://docs.weatherxm.com/glossary +Markdown: https://docs.weatherxm.com/llms-pages/glossary.md + +| Term | Description | +| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Barometer | A barometer is a device that measures the pressure of the air pushing on it—this measurement is called the barometric pressure. We don’t actually feel the barometric pressure because the air pressure is pushing equally in every direction. | +| HectoPascals (hPa) | This is an international standard (SI system) for measuring air pressure. It used to be referred to as milli-bar (mb) and sometimes still is. They are equivalent. | +| Hygrometer | The instrument that measures the relative humidity of the air. This is expressed as a percentage between 0% and 100%. | +| Millimetres (mm) | This is the unit in which the rain amount is measured. 1 mm corresponds to 1kg/m² of water. | +| Rain Rate | Rain rate is a measurement of the intensity of rainfall. It gives the amount of rain that would fall over a time period if the rain rate was constant over that time period. It is usually measured in millimetres per hour (mm/h). | +| Relative Air Pressure | Relative air pressure is the absolute air pressure compensated for the altitude of the barometer. The result is what the air pressure would be at sea level. This measurement appears on the WXM-M5 screen. | | +| Relative Humidity (RH) | It is a measure of the water vapour content of air. In particular, RH is the percentage (%RH) of water vapour that is present in a sample of air to the amount needed to achieve saturation at the same temperature. | +| Ultra Violet (UV) Index | The ultraviolet index or UV-Index (UVI) is an international standard measurement of the strength of sunburn-producing ultraviolet (UV) radiation at a particular place and time. The purpose of the UV Index is to help people effectively protect themselves from UV radiation. The UV Index is a linear scale, with higher values representing a greater risk of sunburn (which is correlated with other health risks) due to UV exposure. An index of 0 corresponds to zero UV radiation, as is essentially the case at night. An index of 10 corresponds roughly to midday summer sunlight with a clear sky when the UV Index was originally designed, but values above 10 are sometimes possible. Levels above 8 are considered “very high” and above 11 are considered “extreme.” | +| Wind Direction | Wind direction is defined as the direction the wind is coming from. | +| Wind Speed | Wind speed is the speed of the weather-related air movement from one place to the next. | +| Wind Gust | Highest measured wind speed over a 10 minute period. | + +--- +# Introduction +Canonical: https://docs.weatherxm.com/introduction +Markdown: https://docs.weatherxm.com/llms-pages/introduction.md + +

+

+ WeatherXM creates an entirely new weather data economy that rewards people + who deploy and maintain weather stations. +

+ + + + +## Introduction + +**_Enter Weather 3.0_** + +**WeatherXM** is a unique weather network that relies on the power of the community to deploy and maintain weather stations. +By doing so, participants not only contribute to the network's growth but also get rewarded with the WXM token. +The network is EVM compatible and is deployed on [Arbitrum One](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6). + +WeatherXM has a vision to become the largest, most decentralised, and most distributed weather network in the world. +You can stay updated on the current state of the network by checking out our [explorer](https://explorer.weatherxm.com). + +Some significant milestones we have achieved so far: + +### Reward Mechanism + +Current [Reward Mechanism v2.0](/rewards/reward-mechanism) includes significant improvements over previous versions. +Business Boost rewards have been added, with predefined criteria for fairness. +A Merkle Tree structure has been implemented for transparent reward distribution. +Users can withdraw their rewards whenever they choose to do so. +The Merkle Tree structure facilitates a verifiable and transparent mechanism for users to validate reward distribution. +These improvements aim to refine the Reward Mechanism, making it more inclusive, nuanced, and transparent to build trust among weather station owners participating in the network. +More on [Reward Mechanism](/rewards/reward-mechanism). + +### Weather stations + +WeatherXM weather stations are not generic sensors. They are purpose-built devices designed to operate as trusted, upgradeable data sources in a decentralised network. + +All stations run custom WeatherXM firmware that is remotely updateable (FOTA updates). This allows continuous improvement of measurement techniques, calibration logic, and data processing without hardware replacement. The same update mechanism is also used to add new features over time, keeping deployed stations up to date and allowing improvements to be rolled out across the entire network in controlled way. + +Every data point produced by a station is cryptographically signed at the source. Stations sample environmental data every 16–20 seconds (depending on the model), then aggregate these high-frequency readings inside the device into 1–3 minute data packets (depending on the configured mode) before signing and transmission. This signature proves that the data originated from a specific physical station and that it has not been altered in transit or storage. As a result, users can verify authenticity rather than rely on trust assumptions. + +Each station also includes a GPS receiver. The reported location is cryptographically signed and can be verified ensuring that both the measurements and their geographic location originate from the device. This prevents location spoofing and enforces the integrity of hyperlocal weather data across the network. + +Together, remote upgradable firmware, on device cryptographic signing, and GPS backed location verification form the technical foundation that differentiates WeatherXM stations and enables a verifiable, high quality weather data economy. + +### Data Quality + +[Data Quality](/rewards/data-quality) is an algorithm that assesses the quality of weather data provided by a weather station. The score it generates shows how confident we can be in the quality of the data received. Our goal is to make sure that the data we receive is meaningful and usable, and the Data Quality score helps us measure this metric. Ultimately, we want to encourage weather station owners to follow our guidelines so that they can consistently achieve the best possible Data Quality score. + +To achieve this, Data Quality Algorithm relies on a range of techniques and processes designed to help us differentiate between expected and unexpected data behaviors. +More on [Data Quality](/rewards/data-quality). + +### WeatherXM Pro + +[WeatherXM Pro](/weatherxm-pro) is our premium service that provides enhanced access to hyperlocal weather data, advanced analytics, +and integration-ready tools — designed for professionals, developers, and businesses that rely on accurate, location-specific forecasts and hyperlocal data. + +### WeatherXM Devices + +Currently we use 4 main types of devices: + +- [WeatherXM M5 Bundle (WB1000)](/wxm-devices/m5/introduction) which is the WiFi version +- [WeatherXM Helium Version (WS2000) ](/wxm-devices/helium/introduction) which is the Helium version +- [WeatherXM D1 bundle (WB1200)](/wxm-devices/d1/introduction) which is the upgraded WiFi version +- [WeatherXM Pulse bundle (WB3000)](/wxm-devices/pulse/introduction) which is the 4G/LTE version + +--- +# How to change password to your account +Canonical: https://docs.weatherxm.com/mobile-app/change-password +Markdown: https://docs.weatherxm.com/llms-pages/mobile-app/change-password.md + +In order to change your account's password you need to use our mobile app. There are different methods of resetting your password whether you are logged in or out. + +:::caution +The confirmation email to change your account password normally arrives within some minutes. + +If you haven't received the email, contact our support team at [Support](https://support.weatherxm.com/hc/en-us) + +Please, do not forget to also check your **spam** folder. +::: + +### Logged in +- Go to My profile, then choose "Preferences & Settings" and press "Change Password" button, enter your account's email. You will receive an email with a link to change your password. + + + +### Logged out + +- Open the App and the login page must appear, press "Forgot password" button, enter your account's email. You will receive an email with a link to change your password. + + + +:::note +- **The instructions above are for both versions of the App (Android and iOS).** +::: + +--- +# Delete WXM Account +Canonical: https://docs.weatherxm.com/mobile-app/delete-account +Markdown: https://docs.weatherxm.com/llms-pages/mobile-app/delete-account.md + +:::caution +By deleting your account, you will **no longer be eligible to gain WXM rewards**, and you will **no longer be able to view your station data** in the WeatherXM apps. + +This **will delete** the following data: + - Your name. + - Your email address. + - Your station(s) details, their location, and their token rewards history. + +This **will not delete**: + - The weather data you’ve shared with the network. + - The WXM rewards you’ve collected. These are yours forever! + +#### We do not collect nor store any other personal data! + +If you have any questions regarding your data and the deletion of your account, please contact our [support team](https://support.weatherxm.com) +::: + +
+ + + +Go to the settings screen and press "Delete Account" button, read carefully the instructions. **This procedure is irreversible** + +
+ +--- +# Add/edit wallet address +Canonical: https://docs.weatherxm.com/mobile-app/wallet/add-edit-wallet-address +Markdown: https://docs.weatherxm.com/llms-pages/mobile-app/wallet/add-edit-wallet-address.md + +:::tip +If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +::: + +## Add wallet address for the first time + +To add your wallet address, go to settings screen and tap "My wallet", then fill or scan your wallet address where you can find at your metamask account, read and accept the terms and services and acknowledge that you have ownership and full access to this wallet. + + + + + +
+ +## Edit your wallet address + +To edit or change your wallet address, go to settings screen and tap "My wallet" and tap on "Edit Wallet Address". In order to edit the Wallet Address you need to confirm you are the owner of this account. + + + + + +
+ +## How to create wallet on Metamask + +\$WXM is deployed on Arbitrum One Network. We suggest you use a **MetaMask** wallet with WeatherXM, as we have extensively tested on it. As we evolve, we will official support several wallets. +By following our guide, it's fairly simple to set up a MetaMask wallet and add a custom token (in our case, the \$WXM token) on Arbitrum One Network. + +:::note +The following guide has been written with the **MetaMask browser extension** in mind. +The steps may vary on other platforms like the mobile app. +::: + +## Installing and setting up MetaMask + +MetaMask is a crypto wallet app and browser extension. + +:::caution +Only install this wallet from the [official MetaMask website](https://metamask.io/download/)! +::: + +1. MetaMask is available to download and install on Chrome, iOS, and Android through the [MetaMask website](https://metamask.io/download/). +Always check if you are using the official website to make sure you’re installing the real MetaMask extension. +1. After installing the extension, you’ll be greeted with the MetaMask welcome page. Click [Get Started] to begin. +1. If you’re creating a new wallet, click the [Create a Wallet] button. You can also import an existing wallet using its seed phrase with the [Import wallet] option. +1. MetaMask will ask you if you’d like to share anonymous usage data with them to help improve the extension. Accepting or refusing this will not affect your MetaMask usage. +1. Choose a secure password to log in to your wallet from your browser. Note that this is not your seed phrase. The password is a security measure to prevent anyone using your device from accessing your wallet. + If you forget your password, you can always access your crypto with your seed phrase. +1. After choosing your password, MetaMask will present you with information regarding your wallet’s seed phrase. Make sure to read through it if you aren’t familiar with how a crypto wallet works. +1. You’ll now be presented with your seed phrase. Click the lock to view the words and take note of them in the correct order. Keep the phrase in a secure place (preferably offline) and never share it with anyone. + This string of words is the final backup of your wallet and its contents. Click [Next] to continue. +1. You’ll now have to repeat your seed phrase by selecting the words at the bottom of the screen in the right order. Click [Confirm] once this is complete. +1. Your MetaMask wallet will now be set up and ready to use. Click [All Done] to view your wallet. + +:::note +If you want to confirm the existence of your tokens in your preferred wallet, you need to add our ERC20 token's smart contract. See how [here](/rewards/how-to-join-arbitrum-and-see-your-tokens#add-wxm-token-in-metamask) +::: + +--- +# Cell Capacity (CC) +Canonical: https://docs.weatherxm.com/rewards/cell-capacity +Markdown: https://docs.weatherxm.com/llms-pages/rewards/cell-capacity.md + +**Cell Capacity (CC)** is a parameter that is used to define the maximum number of stations that may receive rewards in a specific cell. + +Each cell has a predetermined capacity that depends on its unique geospatial features. The capacity of a cell is the maximum number of weather stations that are eligible for rewards in that particular cell. +If there are 'N' rewardable weather stations in a cell with a capacity of 'CC' on a given day, and if N exceeds CC, then only the first N stations +(ordered first by their reward score, defined in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section, and then by seniority) will receive rewards. + +:::tip +Cell capacity is a parameter that is used to define the maximum number of stations that are eligible for rewards in a specific cell. Every cell has a predefined capacity that depends on its geospatial characteristics*. +::: + +### Last Claim Time (LCT): +Claim time is a unix timestamp (integer). +Last Claim Time is set to the timestamp of the last claim of the station. It is used as a **seniority indicator** ( LCT1{'<'}LCT2 then station 1 is more senior than station 2). + +### Cell Ranking: +Cell ranking is a way to measure how well a station performs compared to others within the same area, which is about 5 square kilometres (2 square miles) on the planet. Each station is ranked every day based on their reward score and seniority. +If a station's ranking is above the capacity threshold, it will be rewarded. +However, if the ranking falls below the threshold, the station won't receive any rewards. For instance, in a cell with a maximum capacity of 5 stations, a station that is ranked 3rd would be rewarded, but a station ranked 7th would not receive any rewards. + +## Related articles +- [We are opening the WeatherXM cell modelling to the world (WeatherXM Blog)](https://blog.weatherxm.com/we-are-opening-the-weatherxm-cell-modelling-to-the-world-b827f1c10c2d) +- [Defining the density of a multi purpose global weather network (WeatherXM Blog)](https://blog.weatherxm.com/defining-the-density-of-a-multi-purpose-global-weather-network-ea5f4190f91a) + +:::note +The cell capacity is currently set to the fixed value of 10 rewardable stations, for every cell. +::: + +--- +# Data Quality +Canonical: https://docs.weatherxm.com/rewards/data-quality +Markdown: https://docs.weatherxm.com/llms-pages/rewards/data-quality.md + +:::info +Data Quality algorithm is currently on version 1.0. This page serves as both an informational resource about its current status and a glimpse into its future. +::: + +**Data Quality** is an algorithm that evaluates the quality of weather data provided by a weather station. +The calculated score indicates the confidence level in the quality of the weather data received from a station. +We need meaningful and usable data and the Data Quality score is an attempt to quantify this metric. +The end goal is to encourage weather station owners to do their best to comply with the Network's guidelines in order to consistently +achieve the best Data Quality score possible. + +>![QoD current state](image) + +It’s the method we use to assess the quality of each data point we receive from WeatherXM stations. +Data Quality algorithm involves a series of techniques and processes designed to help us distinguish between expected and unexpected data behaviors. + +This mechanism includes the following 3 control points and their respective checks: +1. Self Check + * Out-of-Bounds Check (OBC) (Data Quality v1.0) + * Self Quality Check (SQC) (Data Quality v1.0) +2. Reference Check + * Comparative Quality Control (CQC) (Data Quality v1.3) +3. Deployment status + * Indoor Station Detector (ISD) (Data Quality v1.1) + * Solar Obstacle Detector (SOD) (Data Quality v1.2) + * Wind Obstacle Detector (WOD) (TBD) + +The Data Quality algorithm is designed to be a daily process, with the exception of the Deployment Status. + +## 1. Self Check +Self-check is the basic component of the Data Quality algorithm, designed to identify common faults within datasets using only the data from the weather station being investigated. Self-check should run once per day. The following steps are included: + +### a. Out-of-Bounds Check (OBC) +OBC is a simple process that involves identifying values that fall outside the specifications set by the manufacturer for each sensor. +As an example, if the temperature sensor is able to measure within a temperature range of -60 to 60°C, then the value 80°C is considered as faulty. + +### b. Self Quality Check (SQC) +SQC is the process that identifies unexpected behaviour in the measured parameters, which could be attributed to a defective sensor or an improper station deployment. +It should be noted that OBC is included in SQC as the first step of this process. +The final result of this process is the annotation of the data in 3 levels: + +- Raw (16’’ or else depending on weather station’s specs) +- Minute (1’ or 2’ depending on the parameter) +- Hourly (aiming to reward each of 24 slots of a day) + +The following processes take place (excluding OBC): + +- Re-framing the timescale of raw data at a fixed time interval (as raw data may not always be measured at a constant time-step) +- Looking for time-slots with no data +- Looking for constant data over a certain period (e.g., constant temperature over an hour, or constant wind speed/direction over an hour under freezing -or not- conditions) +- Looking for unexpected jumps of consecutive raw data or averaged values of consecutive minutes +- Calculating the percentage of valid data within a certain period (minute, hour) + +The final result is text/numerical annotations and percentage of valid data over each time-slot in raw/minute/hourly level. Validity for meteorological purposes may differ compared to validity for reward purposes. Thus, there is a final annotation of each hour slot for meteorological and reward purposes. + +## 2. Reference Check +This part of Data Quality algorithm focuses on comparing the data of a weather station with: + +a. Another neighbouring reliable weather station of the WXM network

+b. Another neighbouring reliable 3rd party weather station

+c. 3rd party post-processed modelled weather data (a process similar to data assimilation) + +The Reference Check may be able to detect abnormal behaviour of the parameters measured by a station. +Such a control could give insight in the quality of both data and deployment +(e.g., temperature diurnal cycle of a station agrees with a reference timeseries, temperature of a station is usually higher because it is close to a chimney etc). + +### Comparative Quality Control (CQC) +In order to apply this control we deploy the Comparative Quality Control (CQC), +which falls into an internal and external version depending on the type of data used for the analysis +(internal -using data owned by WXM- and external -using 3rd party data-). +Reference Check should run once per day together with Self Check. + +## 3. Deployment Status +The Deployment Status control can be used as an identifier of the obstacles around a weather station. As solar irradiance and wind are parameters that are fairly sensitive to obstacle interventions, two different processes have been designed to determine the quality of deployment: + +a. Indoor Station Detector (ISD)

+b. Solar Obstacle Detector (SOD)

+c. Wind Obstacle Detector (WOD) + +Both processes require a long timeseries typically of a few weeks to a few months, thus they should run once per a few months or a year. +This means that the Deployment Status part of Data Quality algorithm can only be used to characterise the deployment of a weather station. + +### a. Indoors Station Detector (ISD) +The purpose of this mechanism is to identify all the stations located in a house or a box. +This process requires solar irradiance, latitude, longitude and day of the year. + +### b. Solar Obstacle Detector (SOD) +This process examines the solar irradiance parameter comparing it with the theoretical solar irradiance expected for a given location and day of the year. Note that the theoretical solar irradiance is the total amount of solar irradiance that arrives at a horizontal surface on the Earth under clear sky conditions. +Because of that, a long period of data is required for detecting a totally clear-sky day. This method: + +- Detects a clear sky day +- Compares theoretical and observed solar irradiance on a clear-sky day +- Compares observed solar irradiance within a short period (e.g., a 5-day window), in order to find similarities (i.e., systematically decreased solar irradiance at a certain period of day) + +The limitations of this method are that: +- Only south horizon of a station can be examined for obstacles +- The solar angle is different from a season to another, thus different obstacles may be visible at different period of the year + +Despite of such limitations, it is still a useful method for detecting obstacles that may affect solar irradiance, but also the other parameters. + +### c. Wind Obstacle Detector (WOD) +As wind is the most demanding (in terms of fulfilling the WMO deployment criteria) parameter, this method should be able to identify any significant obstacles around a weather station. + +The basic idea is that we collect measurements of significant wind (e.g., >5m/s) of all the 16 direction of wind and then we compare them with wind measurements of a reference station or post processed modelled data. Then, the directions at which wind speed is significantly underestimated are suspicious for obstacles. + +This mechanism can be used to characterise the general deployment of a weather station, but can also identify the directions that wind measurements may not be reliable. + +## Data Quality Threshold +Data_Quality_Threshold is a rational number in the range [0,1]. +This number indicates the minimum Data Quality score a station must have on a given day in order to be eligible for rewards. + +## Data Quality Components Outcome +>![The Data Quality Components](image) + +:::note +Data Quality score is a rational number in the range [0,1] +::: + +## References +- [WeatherXM Network](https://weatherxm.network/) +- [Data Quality Simplified - Medium article](https://medium.com/weatherxm/weatherxm-qod-quality-of-data-simplified-b5a42aee7367) +- [Technical description of the process for Data Quality v1.0](https://docs.google.com/document/d/e/2PACX-1vR5UTaVXtmoXnbnpukE5ocFOcYjZAiuFH4mZU6Wgkj0OP7sAVYh5ep3PgMxyJe61uqaq9TAdHPbi-TU/pub) + +--- +# Hardware Class +Canonical: https://docs.weatherxm.com/rewards/hardware-class +Markdown: https://docs.weatherxm.com/llms-pages/rewards/hardware-class.md + +Hardware-Class Weight (HCW): HCW is a rational number > 0. + +Each type of approved hardware (weather station) belongs to a specific Hardware Class. +Hardware Classes are used to award more tokens to weather stations that have special capabilities, +increased sensor accuracy or range, new sensor types, or other capabilities that make them more valuable to the network. + +:::note +For the time being all Hardware Classes are considered equal. +::: + +--- +# How to join Arbitrum and see your tokens +Canonical: https://docs.weatherxm.com/rewards/how-to-join-arbitrum-and-see-your-tokens +Markdown: https://docs.weatherxm.com/llms-pages/rewards/how-to-join-arbitrum-and-see-your-tokens.md + +:::tip +If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +::: + +## Add Arbitrum One Network to Metamask + +Adding Arbitrum One Network support to MetaMask is a mandatory step in order to add the WXM token, view activity, and make transactions. +Make sure you follow our step-by-step guide below for adding the Arbitrum One Network to MetaMask. + +You can add Arbitrum One Network to MetaMask by following the instructions below: + +### Using Arbiscan + +:::note +Please make sure you have already installed **[MetaMask](https://metamask.io/)**! + +**This solution works only on desktop with the MetaMask browser extension already installed.** +::: + +Please follow the steps to add Arbitrum One Mainnet: + +- Navigate to [Arbiscan.io](https://arbiscan.io/) +- Scroll down to the bottom of the page and click on the button `Add Arbitrum One Network` + ![Arbitrum One](image) + +- Once you click the button you will see a MetaMask notification, now click on **Approve**. +You will be directed to Arbitrum's Mainnet in the network dropdown list. You can now close the dialog. + + +
+ +## Add WXM token in MetaMask + +For the WXM token to appear in the wallet UI, you will need to add it manually. +Note that your wallet can still receive tokens that haven’t been imported. + +:::note IMPORTANT NOTE +Please make sure you have already added the **Arbitrum One** and have connected to it by following the guide above! +::: + +1. First, you will need the following details of the WXM token in order to add it: + 1. **Token Contract Address:** ``0xB6093B61544572Ab42A0E43AF08aBaFD41bf25A6`` + 1. **Token Symbol:** ``WXM`` + 1. **Token Decimal:** ``18`` + + You can verify those details on [Arbiscan](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6). +1. On MetaMask and click **[Import tokens]**. +1. Paste in the WXM’s contract address and MetaMask should automatically fill in the rest of the details. If not, add them manually. To finish, click **[Add Custom Token]**. +1. Click **[Import Tokens]**. + +**You have now successfully added the WXM token to your MetaMask wallet!** + +--- +# Proof of Location (PoL) +Canonical: https://docs.weatherxm.com/rewards/proof-of-location +Markdown: https://docs.weatherxm.com/llms-pages/rewards/proof-of-location.md + +The **Proof-of-Location** algorithm evaluates location data associated with the station, their accuracy, and consistency. It generates a score which is a confidence indicator about the station’s location. WeatherXM places great importance on station continuity, and discourage relocations. + +## Proof-of-Location (PoL) +PoL is a rational number in the range [0,1]. +A station’s PoL must be greater than or equal to PoL_Threshold to be considered for inclusion in WeatherXM's **Rewarding Mechanism**. +PoL is a dynamic value, and is recalculated every time a station’s location is updated. + +### Calculation: +Currently, PoL is calculated daily using Location Packets. +- For M5, D1 and Pulse, at least one accurate Location Packet from the previous day is required to determine the Location. +- For H1 stations, at least one accurate Location Packet from the previous day is required to determine the Location, if no Location Packets are available, the PoL algorithm will rely on data from the day before. + +## Relocation +It is important for the Network that a station remains at the same location throughout its lifetime. +When a weather station undergoes relocation, its Proof of Location score reduces to 0 for 7 days and its seniority is reset. +After 7 days, the station’s PoL is recalculated, and if it is greater than or equal to PoL_Threshold, the station is considered for inclusion in the [WeatherXM Network](https://weatherxm.network/). + +:::info +Proof of Location penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: + +:::note +PoL is a rational number in the range [0,1] +::: + +--- +# Reward Boosts +Canonical: https://docs.weatherxm.com/rewards/reward-boosts +Markdown: https://docs.weatherxm.com/llms-pages/rewards/reward-boosts.md + +## Overview + +**Reward boosts** are additional rewards given to stations that contribute weather data during daily distribution, in addition to the [**base rewards**](/rewards/reward-mechanism#daily-rewards-calculation-process). Learn more about the daily rewards in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section. + +**Reward Boosts** reward stations with extra $WXM tokens for meeting specific criteria. + +So far the following **Reward Boosts** are scheduled to be implemented: + +## Beta Rewards + +According to the [Token Allocation table](https://weatherxm.network/docs/wxm-token.html#token-allocation), 3M $WXM are reserved to reward stations that participated to the network before the Mainnet Launch Day ("Beta period"). + +Beta rewards distribution will last 425 days. + +### Calculation + +The following calculations will take place for each station, the day before the Mainnet Launch: + +$$RewardableBetaHours[i]$$: This is the total number of hours the station provided valid data during the Beta period. +A rewardable hour is an hour during which the station sent at least one valid weather data point. + +$$StationBetaRewards[i]$$: This is the percentage of the 3M tokens that correspond to the rewardable hours the station provided. +$$ +StationBetaRewards[i] = \frac{3000000 \times \text{RewardableBetaHours}[i]}{\sum (\text{RewardableBetaHours of all stations})} +$$ + +$$DailyBetaRewards[i]$$: This is the beta rewards allocated daily to this station. +$$ +DailyBetaRewards[i] = \frac{\text{StationBetaRewards}[i]}{365} +$$ + +## Beta Rewards Dilution - A fix + +Initially, the reward allocation formula caused dilution as the launch day was delayed, disadvantaging long-term station owners. + +### Updated Beta Rewards Allocation + +The updated approach involves calculating beta rewards twice: once at the end of February 2024 and again just at the end of the project's beta phase (May 27 2024). +Each station will receive the higher reward of these two calculations, ensuring fairer distribution of rewards across both old and new stations. + +Read more about the Beta Rewards Dilution fix [here](https://blog.weatherxm.com/a-fix-for-beta-rewards-dilution-493f1a81a28d). + +### Beta Rewards Table (BRT) + +The project's Beta period officially ended on May 27th (UTC). All station-hours accumulated up to this date are included in the final calculation and all stations are rewarded for participating in the Beta period with a daily Reward Boost. + +Download the BRT here: [CSV](https://weatherxm.network/wxm-brt-final.csv) + +:::info +Each user who has a station eligible for beta rewards, must have a wallet defined to be part of the Beta Rewards allocation. Learn [how to add or edit a wallet address](/mobile-app/wallet/add-edit-wallet-address). +::: + +:::note +The Beta Rewards allocation is managed by the [WeatherXM Network](https://weatherxm.network). +::: + +## Compensation Rewards + +Compensation Rewards are a special type of boost rewards which are meant to distribute tokens which were initially not allocated due to system and/or algorithm malfunctions. + +### Calculation Process + +For each day that an incident such as the above may have occurred, the correct network snapshot is reconstructed and the rewarding mechanism is re-ran in order to calculate +each station's intended reward score and consequently rewardable tokens. + +### Incident History + +| Date | Number of stations affected | Tokens Distributed | +|------|----------------------------|-------------------| +| 2025-02-03 | 5110 | 12186.48 $WXM | +| 2025-03-09 | 16 | 29.15 $WXM | +| 2025-05-01 | 7470 | 3923.771 $WXM | + +## Cell Bounties + +Cell Bounties are special incentives that boost rewards for weather stations deployed in high-priority areas and are funded by consumers and partners. + +:::info +Any currently open cell bounties may be viewed in [WeatherXM Explorer](https://explorer.weatherxm.com). +::: + +Stations which are deployed at bounty cells within the announced participation period will be eligible to receive extra rewards. Each bounty defines a maximum number of stations +which may share the rewards. Should the number of eligible bounty stations exceed the bounty capacity, a ranking based on [QoD scores](/weather-and-science/quality-mechanisms/general-qod-description) and seniority is used +to distribute rewards fairly. **Stations must meet a minimum of 0.8 QoD score to receive rewards**. + +## Examples of reward programs that may be implemented using **Rewards Boost**, in the near future are: + +- Public Goods Funding, for devices that are deployed and contribute to the network in a humanitarian way, such as providing data in an underserved area or during a specific time. +- Devices that contribute to the network during a specific event, such as a natural disaster, may receive a boost in rewards. + +:::tip +The **Reward boosts** is a mechanism that can be used to incentivise specific behavior from devices. It is a flexible mechanism that can be used to incentivise any behavior that is beneficial to the network. +::: + +:::info +All the above are **examples** of reward programs that may be implemented. +::: + +--- +# Reward Mechanism +Canonical: https://docs.weatherxm.com/rewards/reward-mechanism +Markdown: https://docs.weatherxm.com/llms-pages/rewards/reward-mechanism.md + +## Introduction + +:::info +The Reward Mechanism is currently at **version 2.0**. This page serves as both an informational resource about its current status and a how we got here. +::: + +The Reward Mechanism has undergone a progressive evolution across its versions, each iteration introducing refinements to bolster fairness and transparency in the rewarding process for weather station owners contributing data to the network. + +- In its inaugural version (v1.0), the mechanism primarily gauged a station's eligibility based on its connection status to the network and the requirement for active wallet ownership, resulting in a somewhat simplistic reward calculation. In this version, the users received in a daily basis the WXM testnet rewards at their wallets. +- The subsequent release, v1.5, marked a significant advancement by expanding the criteria for reward eligibility. This version incorporated additional factors such as the Data Quality, Proof-of-Location (PoL), Hardware-Classes (HC) and the Cell-Capacity (CP). + These additions contributed to a more sophisticated and equitable system, ensuring that rewards were allocated based on data quality, accurate location proof, and user engagement. +- The third iteration, v2.0, will introduce substantial enhancements, including the incorporation of Business Boost rewards and the implementation of a Merkle Tree structure for transparent reward distribution. The utilization of Merkle Tree will lead users in withdrawing, whenever they choose to do, their rewards from the smart contract. + Business Boost rewards added an additional layer of fairness by incorporating predefined criteria, while the Merkle Tree structure facilitated a verifiable and transparent mechanism for users to validate the distribution of their rewards. + This evolutionary trajectory underscores a commitment to refining the Reward Mechanism, making it more inclusive, nuanced, and transparent to build trust among weather station owners participating in the network. + +## Reward mechanism v2.0 + +The Reward Mechanism v2.0 is the latest iteration of the rewarding mechanism. It is a significant advancement over the previous version, v1.5, and it introduces the following enhancements: + +### High-level flow + +Every day, the reward algorithm assesses the performance of all weather stations, calculates additional rewards originating from Business Boost use cases, bundles them together with the users' wallet addresses, and creates a Merkle Tree, the root hash of which is submitted to the RewardPool. + +Users have the option to withdraw their rewards either by accessing the Merkle proof on the WeatherXM Platform or by retrieving the Merkle proof from IPFS and programmatically initiating the procedure. At any given time users have the flexibility to withdraw any amount they desire, provided it does not exceed the total allocated amount. + +### Daily Rewards Calculation Process + +The Reward Mechanism calculates the amount of tokens that will be allocated to users by completing the following phases: + +1. Base Rewards calculation +2. Business Boost Rewards calculation +3. Cumulative Rewards calculation +4. Merkle Tree creation + +Let's take a deep dive into each one of these. + +#### 1. Base Rewards calculation + +Base rewards calculation follows the **Actual Rewards Calculation** already introduced in **Reward Mechanism v1.5**. + +#### 2. Business Boost rewards calculation + +The business boost use cases reward specific devices with a predefined amount of tokens from the Business Development Pool for a period of time. In this phase, all business boost rewards are calculated for each active business boost use case and they are assigned to the eligible devices. + +#### 3. Cumulative Rewards Calculation + +In the third phase of the rewarding mechanism, the cumulative rewards per user are calculated. The cumulative rewards are the sum of all base and business boost rewards that each user's weather station owns. + +``` +cumulative_rewards_per_customer = sum(base_reward[i] + business_boost_reward[i]), i = 1..n where n = total number of devices per user +``` + +#### 4. Merkle Tree Creation + +In the final phase, the cumulative rewards coupled with the users' wallet addresses are utilised to create the Merkle tree. The root hash of the Merkle tree is submitted daily in the smart contract to enable $WXM rewards withdrawal by the users. + +#### Pseudocode + +To sum up all of the above in pseudocode: + +``` +// base reward +rewardable = { + 'Helium': { + count: 0, + weight: 0.9, + devices: [] + }, + 'M5': { + count: 0, + weight: 1.1, + devices: [] + } +} + +for cell in cells: + cell_devices = [] + for device in cell: + if isEmpty(device.owner.wallet): + device.reward_score = 0 + device.reward_reason = 'NO_WALLET' + device.base_reward = 0 + continue + if data_quality_score < data_quality_threshold: + device.reward_score = 0 + device.reward_reason = 'DATA_QUALITY_THRESHOLD' + device.base_reward = 0 + continue + if pol_score < pol_threshold: + device.reward_score = 0 + device.reward_reason = 'POL_THRESHOLD' + device.base_reward = 0 + continue + device.reward_score = reward_algorithm(device.pol_score, device.data_quality_score) + cell_devices.push(device) + rewardable[device.hardware_class].count += 1 + rewardable[device.hardware_class].push(device) + + cell_devices.sort( (x, y): + if x.reward_score == y.reward_score: + return x.claimedAt - y.claimedAt + return y.reward_score - x.reward_score + ) + + for (device, i) in cell_devices: + device.bb_reward = 0 + if i >= cell.capacity: + device.reward_score = 0 + device.reward_reason = 'MAX_CAPACITY_REACHED' + device.base_reward = 0 + +total_weights = 0 +for key in rewardable.keys: + hc = rewardable[key] + total_weights += hc.count * hc.weight + +for key in rewardable.keys: + hc = rewardable[key] + hc.max_rewards = daily_emission * hc.weight / total_weights + for device in hc.devices: + device.base_reward = device.reward_score * hc.max_rewards + +// business boost +for bb in business_boosts: + for device in bb.devices: + device.bb_reward += bb.daily_reward + +// cumulative calculation +for user in users: + daily_cumulative_rewards = 0 + for device in user.devices: + daily_cumulative_rewards = device.bb_reward + device.base_reward + if not user.active_wallet: + continue + user.wallets[user.active_wallet] = daily_cumulative_rewards + +// merkle tree +tree = [] +for user in users: + for wallet in wallets: + tree.push([wallet, user[wallet].cumulative]) + +// blockchain tx +submit(tree.root_hash()) +``` + +### Withdrawing Rewards + +Station owners have the freedom to withdraw their rewards at their discretion, without any time restrictions or other limitations. + +Each owner may initiate the withdrawal process by signing a transaction using the private key that corresponds to the blockchain address they have connected to their station. A user-friendly front-end that can be used in conjunction with a wallet like Metamask will be provided, but station owners can also interact programmatically with the **RewardPool** smart contract to withdraw their rewards directly. + +### Smart Contracts and Rewarding Mechanism + +The smart contracts and wallets associated with the rewarding mechanism are the following: + +* `WeatherXM`: ERC20 token +* `RewardPool`: smart contract holding users' allocated $WXM rewards +* `RewardVault`: smart contract holding the total amount of $WXM rewards to be allocated +* `BusinessDevelopmentPool`: wallet holding all $WXM leftovers from daily rewards + +The lifecycle of rewards from the rewarding mechanism to the users' wallets: + +* The **Reward Mechanism** calculates all rewards and allocates them to **RewardPool** +* The **RewardPool** holds all allocated rewards +* The **RewardVault** funds the **RewardPool** with the daily emission of $WXM +* The **Business Development Pool** funds daily the **RewardPool** with the business boost of $WXM +* The station owners withdraw their rewards programmatically or through the WeatherXM Platform by interacting with the **RewardPool** + +## Reward mechanism v1.5 +This section describes the updated **Reward Mechanism** that will be used to allocate $WXM rewards to station owners for contributing weather data to the network. (deprecated) + +:::note Important Notes +* Connecting a wallet is mandatory to receive rewards. If a user has not connected a wallet, the rewards will be lost. +* Criteria that should be met for a weather station to be rewardable: + * Data quality over data_quality_threshold + * PoL over pol_threshold + * weather station’s owner should have an active wallet + +::: + +### Daily Rewards Calculation Process +The Reward Mechanism calculates the amount of tokens that will be distributed to users by completing the following phase: + +#### Actual Rewards calculation +Actual rewards are calculated taking into account the performance of the weather station for the previous day. + +This is a short summary of the criteria used: + +* **Proof-of-Location (PoL)**: An algorithm that evaluates the data about the location of the weather station, its accuracy, consistency, and unison with the location the owner registered on the weather station claiming. +It generates a score that denotes confidence about the weather station's location. WeatherXM places great importance on station continuity, necessitating that a station remains stationed at a single location. +When a weather station undergoes relocation, its PoL score reduces to 0 and its seniority in the Cell is reset, aiming to discourage frequent movements and sustain a stable Network. Read more about the [Proof of Location (PoL) mechanism](/rewards/proof-of-location). + +* **Data Quality**: An algorithm that evaluates the quality of weather data provided by a weather station. It generates a score that denotes the confidence about the quality of the weather data for each weather station. + WeatherXM values weather stations that produce meaningful and usable data and the Data Quality score is an attempt to quantify this metric. The end goal is to encourage weather station owners to do their best to comply with WeatherXM's + guidelines in order to consistently achieve the best Data Quality score possible. Read more about the [Data Quality algorithm](/rewards/data-quality). + +* **Hardware-Class (HC)**: Each type of approved hardware (weather station) belongs to a specific Hardware Class. Hardware Classes are used to award more tokens to weather stations that have special capabilities, +increased sensor accuracy or range, new sensor types, or other capabilities that make them more valuable to the network. For the time being all Hardware Classes are considered equal. Read more about the [Hardware class](/rewards/hardware-class). + +* **Cell Capacity (CC)**: Each cell has a pre-defined **cell capacity** that depends on its geospatial characteristics. The cell's **capacity** is the maximum number of stations that may receive rewards in a specific cell. +If `N` weather stations are active in a cell with a capacity `X` during a specific day, with `N > X`, only the first `N` stations (ordered first by **reward_score**, then by seniority) will receive rewards. Read more about the [Cell Capacity (CC)](/rewards/cell-capacity). + +We will split the process into 5 distinct steps in an attempt to make everything as clear as possible. + +a. The following variables have known values at the start of each day: + +* `daily_emission`: the amount of tokens that are available for allocation on the given day +* `weight_per_hardware_class`: the number denoting how important an HC is compared to all the other HC +* `pol_threshold`: the number denoting the cut-off threshold for PoL: weather stations with `pol_score`` < pol_threshold` are **excluded** from rewarding +* `data_quality_threshold`: the number denoting the cut-off threshold for Data Quality: weather stations with `data_quality_score < data_quality_threshold` are **excluded** from rewarding +* `capacity` per cell: the maximum number of weather stations that will be rewarded in a cell - the rest are **excluded** from rewarding + +b. To calculate the rewardable count of devices per **HC**: + +* we exclude weather stations that are owned by users with no wallet address specified +* we count the weather stations with **data_quality_score** and **pol_score** over the respected specified thresholds, `data_quality_threshold`, `pol_threshold` The number of stations that pass this evaluation are eligible for rewards. + +c. To calculate the **max_reward_per_hardware_class (MRPHC)**: + +``` +total_weights = sum(rewardable_count_per_hardware_class[i] * weight_per_hardware_class[i]), i = 1..n, where n = total number of HC +``` + +For every HC: + +``` +tokens_per_hardware_class = daily_emission * (rewardable_count_per_hardware_class * weight_per_hardware_class) / total_weights + +max_reward_per_hardware_class = tokens_per_hardware_class / rewardable_count_per_hardware_class +``` + +d. To calculate the **reward_score** and **actual_reward**: + +``` +reward_score = pol_score * data_quality_score + +actual_reward = reward_score * max_reward_per_hardware_class +``` + +e. To identify overcrowded cells and decide which of the weather stations will be excluded from rewarding: + +* we iterate over available cells and check whether it is overcrowded +* in case it is indeed overcrowded, we sort the neighbouring weather stations first by `reward_score` and then by seniority (`claimed_time`). Only the `N` first will be rewarded, where `N = capacity` + +## Reward mechanism v1.0 + +The first iteration of **Reward Mechanism** operates in the following way: only taking into account whether or not a station is connected to the network. (deprecated) + +The reward distribution mechanism has two parts: + - **The reward algorithm** which calculates the `actual_reward` for each weather station by evaluating its weather data for the previous day + - The daily **reward distribution** of rewards to the station owners + +:::note Important +Connecting a wallet is mandatory to receive rewards. If a user has not connected a wallet, the rewards will be lost. +::: + +### How Often does the Reward Algorithm run? +The algorithm runs every day to reward weather stations that were actively sending data to the network for the previous day. + +### Calculation of the Reward Score +`reward_score = array_of_hourly_weather_data / 24` + +### Explanation +In the calculation of the `reward_score` step, the algorithm takes into account the weather data for each hour of the previous day for any given weather station. + - If the weather station has successfully sent data for each hour of the previous day, then the algorithm's input is an array of 24 objects, + with each object being the station's weather data. + - If the weather station hasn't sent any weather data for 1 or more hours the previous day, then the algorithm's input is an array of (`24 - X`) objects, + with each object being the station's weather data and `X` being the number of hours that the station hasn't communicated with our system. + +That input is then being used by dividing its length by 24 (the maximum hours per day) to get a `reward_score` of `0.0` to `1.0`. + +After the calculation of the `reward_score` step, the algorithm takes the `reward_score` for any given weather station in our network, multiplies it with the `max_daily_reward` that the weather +station can get, and the result is the amount of WXM tokens that the algorithm distributes to the user who owns that weather station. + +The formulas which are used to calculate the daily reward per weather station is the following: +``` +rewardable_count = Count(all_provisioned_weather_stations) +max_daily_reward = daily_emission / rewardable_count +weather_station_reward = reward_score * max_daily_reward +``` +### Reward Distribution Mechanism +All daily `actual_reward` per weather station are transferred to the wallet address already set by the user. +This is a bulk transfer operations which happens once in a daily schedule and as a result the users get their daily rewards to their wallets. +Due to blockchain limitations on the number of atomic transfer transactions that may take place with each bulk transfer, as many as needed bulk transfers can be executed for the purpose of everyone getting the daily rewards. + +## Links +- [WeatherXM Network](https://weatherxm.network/) +- [Data Quality algorithm](/rewards/data-quality) +- [Proof of Location (PoL) mechanism](/rewards/proof-of-location) +- [Cell Capacity (CC)](/rewards/cell-capacity) +- [Hardware class](/rewards/hardware-class) + +--- +# How to Claim Rewards +Canonical: https://docs.weatherxm.com/rewards/rewards-claiming +Markdown: https://docs.weatherxm.com/llms-pages/rewards/rewards-claiming.md + +:::tip +Allocated and claimed tokens displayed in our mobile apps, are only those linked to your current wallet. +This does not include any wallets you may have used in the past. +::: + +## Prerequisites for claiming rewards + +In order to claim your $WXM rewards: + +1. You must have a wallet with Arbitrum One network configured. If you have not done so, please follow the [Wallet Setup](/rewards/how-to-join-arbitrum-and-see-your-tokens). +2. You must have some ETH in your wallet which are needed as gas fees. + +
+ +## Claiming rewards + +To claim your rewards: + + + + + +1. Open the WeatherXM app. +2. Navigate to "My Profile" +![My Profile](image) + +3. Then press the "Claim" button. +4. Follow the instructions and "connect your wallet". +![connect_wallet](image) + +5. Enter the amount you want to claim and press "Next". +6. Then, follow the instructions on your wallet to confirm the transaction. + +**You have successfully claimed your rewards!** + +
+ + + + + +1. Navigate to the [Claim dApp](https://claim.weatherxm.com/). +![My Profile](image) + +2. Connect you Wallet. +3. Enter the amount you want to claim and press "Claim". + +4. confirm the transaction on your wallet. + +5. You have successfully claimed your rewards! + + + + + +### Alternative method for claiming rewards + +1. Navigate to the [Claim dApp](https://claim.weatherxm.com/). + ![My Profile](image) + +2. Connect your Wallet with the WalletConnect option. + ![Wallet Connect](image) + +3. Open your mobile wallet and scan the QR code with that wallet in order to connect with it. + + For example: Rainbow Wallet + ![Rainbow Wallet Scan QR](image) + +4. Enter the amount you want to claim and press "Next". + ![Enter Amount](image) + +5. Confirm the transaction on your mobile wallet. + ![Confirm Transaction](image) + +6. You have successfully claimed your rewards! + ![Claim Success](image) + +
+ +## Bridging your assets from Ethereum to Arbitrum + +1. Go to https://bridge.arbitrum.io/. +2. Then, simply enter the amount of ETH you wish to use on Arbitrum and click “Deposit”. +3. Next, you will need to confirm the transaction in your wallet. Please note that this transaction is on Layer 1 and standard gas fees will apply. +However, once on Arbitrum you can enjoy lower gas fees. Once the amount is correct, click “Confirm”. +4. Once confirmed, you will see the transaction appear and process at the bottom of your screen. This can take a few minutes. +5. If you require additional support to bridge your assets, you can refer to Arbitrum’s tutorial [here](https://docs.arbitrum.io/getting-started-users). + + **This Guide is applicable only on desktop with the MetaMask browser extension already installed.** + +--- +# Rewards Troubleshooting +Canonical: https://docs.weatherxm.com/rewards/rewards-troubleshooting +Markdown: https://docs.weatherxm.com/llms-pages/rewards/rewards-troubleshooting.md + +A guide to interpreting mobile app error messages, understanding their meanings, and taking appropriate actions to resolve them. + +## No wallet + +It seems that you haven't connected a wallet to your account yet. Please note that in order to receive rewards, you must connect a wallet address. Here's what you need to do: + +1. Learn [how to add or edit a wallet address](/mobile-app/wallet/add-edit-wallet-address). +2. Then, follow the instructions for [joining Arbitrum One and see your $WXM tokens](/rewards/how-to-join-arbitrum-and-see-your-tokens). + +Once you've completed the above steps, you'll be all set to claim your rewards. Please wait until the [Reward Mechanism (RM) ](/rewards/reward-mechanism) completes. This usually takes until the following day and see "[How to Claim Rewards](/rewards/rewards-claiming)" for further guidance. + +
+ +## No Station Data + +It seems that your station did not transmit any data at all, which may indicate that it was either offline or not connected to the network. + +Here's what you need to do: + +### For the WG1000 WiFi gateway + + + +

WG1000 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS receiver.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/m5/troubleshooting#weather-station-not-reporting-data-to-wg1000-gateway-there-are-dashes----on-the-display-console). +- Also read through the guide to add the included external antenna [here](/wxm-devices/m5/troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- Check if the station's battery level is low through mobile app settings. +If the battery is low, the connection between your station and the WG1000 gateway will be unstable resulting in data loss. + + + + +- Check your GPS by following the guide [here](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red). +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/m5/troubleshooting#no-wifi--connection). + +### For the WS2000/WS2001 (Helium version) + +1. Check if the station's battery level is low through mobile app settings. +2. Check for [Helium coverage](/wxm-devices/helium/troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. + +
+ +## Sensor Problems + +If you got this error, it means our data evaluation services detected that the received weather packets, did not meet our quality standards. +To ensure the accuracy of the information sent by our weather stations, we evaluate all data packets using our [Data Quality algorithm](/rewards/data-quality). For more information about this algorithm, please refer to this [here](/rewards/data-quality). + +Below are some of the possible errors and the appropriate actions you can take to resolve the issues: + +#### Out of Bounds Data +It's possible that a sensor sends a completely irrational value, which implies to a faulty sensor. If this error persists for multiple days, it is recommended to perform a complete **power cycle**. + +##### Power cycle procedure: +1. Remove batteries. +2. Cover the solar panel so the station isn't powered by the panel while the batteries are out. +3. You should wait 48 hours for the stored power to fully drain. +4. Put batteries back in place and wait for the station to boot up. + +If the above doesn't work, you should contact our [support team](https://support.weatherxm.com) for sensor replacement. + +#### Spikes on Data +One or more of your sensors are exhibiting irrational spikes. You should first check your station if it is optimally deployed and then you should contact [support](https://support.weatherxm.com). +Take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. + +#### Constant Values +One or more of your sensors report constant values which implies a bad installation, or less often, a problematic sensor. If your station is optimally installed and the constant value errors persist for a few days, +you should perform a **power cycle** and if you continue to receive it, contact [support](https://support.weatherxm.com). + +Take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. + +##### Power cycle procedure: +1. Remove batteries. +2. Cover the solar panel so the station isn't powered by the panel while the batteries are out. +3. You should wait 48 hours for the stored power to fully drain. +4. Put batteries back in place and wait for the station to boot up. + +If the above doesn't work, you should contact our [support team](https://support.weatherxm.com) for sensor replacement. + +#### Frozen Sensor +You should remove excess snow or ice from the weather station, and make sure wind cups and wind vanes rotate freely. + +:::tip +If you encounter any errors, it is recommended that you observe it for a few days before reaching out to our [support team](https://support.weatherxm.com). +In case you still receive the error after a couple of days, please do not hesitate to contact our [support team](https://support.weatherxm.com) for further guidance. +::: + +
+ +## Weather Data Gaps + +Some data gaps were detected during our data quality checks. +Perhaps the indoor or outdoor units are not properly connected to the network, or to each other. + +Here's what you need to do: + +### For the WG1000 WiFi gateway + + + +

WG1000 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS receiver.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/m5/troubleshooting#weather-station-not-reporting-data-to-wg1000-gateway-there-are-dashes----on-the-display-console). +- Also read through the guide to add the included external antenna [here](/wxm-devices/m5/troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- Check if the station's battery level is low through mobile app settings. +If the battery is low, the connection between your station and the WG1000 gateway will be unstable resulting in data loss. + + + + +- Check your GPS by following the guide [here](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red). +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/m5/troubleshooting#no-wifi--connection). + +### For the WS2000/WS2001 (Helium version) + +1. Check if the station's battery level is low through mobile app settings. +2. Check for [Helium coverage](/wxm-devices/helium/troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. + +### For the WG1200 WiFi Gateway + + + +

WG1200 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS Receiver of the Weather Station.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/d1/troubleshooting#device-alert-no-weather-station-signal). +- If the station's battery level a warning will appear on the [WG1200 Gateway](/wxm-devices/d1/troubleshooting#one-or-more-variables-are-extremely-high-low-or-constant-for-long-periods-of-time). +- In case your WG1200 GPS arrow icon is red, please contact our [support team](https://support.weatherxm.com) for further guidance. +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/d1/troubleshooting#device-alert-no-internet-connection). + +
+ +## Bad Station Deployment + +It appears that your weather station could benefit from some improvements in terms of its deployment. The [Data Quality algorithm](/rewards/data-quality) evaluates all data packet received by a weather station every day, so a proper installation becomes mandatory to receive the maximum amount of rewards. +We recommend that you take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) for inspiration on how and where to install your station. + +
+ +## No location Data + +Your weather station was suspended from rewards because it did not report GPS data. Please check the troubleshooting guides for your station below, before contacting our support team.[support team](https://support.weatherxm.com). + +### For the WG1000 - WiFi gateway + +1. [No location (GPS) data (arrow icon is red)](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red) +2. [Place the WG1000 near a window (for better GPS signal)](/wxm-devices/m5/connect-and-claim#place-wg1000-gateway-near-a-window-for-better-gps-signal) + +### For the WS2000/WS2001 (Helium version) + +1. [No location (GPS) data](/wxm-devices/helium/troubleshooting#no-location-gps-data) +2. [Installation instructions](/wxm-devices/helium/install-weather-station) + +
+ +## Location Not Verified + +It appears that the location of your weather station is different from the one you had originally set while claiming it. +Please verify your location through the mobile app. + + + + + +In detail, the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flagged your weather station because the location reported by its GPS receiver(s) is different than the location you declared during the setup and claiming of the station. + +This could happen because either you have moved your station from its initial installation site, or you had declared a wrong location during the onboarding process of the station on your mobile app. + +As a result, your station will not be eligible for reward distribution until it is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. + +:::tip +When discussing the weather, we always mention a specific location, either directly or indirectly. Therefore, the data provided by weather stations in the WeatherXM Network is meaningless unless we know the location of each station at all times. +It is crucial for the stability of the Network to have weather stations that can report their current location and remain stationary. +::: + +:::note +[Proof of Location (PoL) mechanism](/rewards/proof-of-location) penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: + +
+ +## User Relocation Penalty + +Our [Proof of Location (PoL) mechanism](/rewards/proof-of-location) reported a relocation event. +It seems like you used the relocation feature and you edited the location of your weather station through the app. Please wait 7 days and your weather station will start earning rewards again. + +WeatherXM places great importance on station continuity, and discourage relocations therefore It is important for the Network that a station remains at the same location throughout its lifetime. + +:::note +The [Proof of Location (PoL) mechanism](/rewards/proof-of-location) penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: + +--- +# The $WXM Token +Canonical: https://docs.weatherxm.com/tokenomics +Markdown: https://docs.weatherxm.com/llms-pages/tokenomics.md + +## The token that enables the WeatherXM ecosystem + +$WXM, issued by the [WeatherXM Network Association](https://weatherxm.network/), is the token that enables the WeatherXM ecosystem. + +\$WXM will be used to govern the Network and will be required to license weather data for commercial uses. Station owners are awarded \$WXM for providing high-quality weather data to the Network. + +View detailed analytics about the $WXM token, including rewards and revenue, on [Dune Analytics](https://dune.com/weatherxm/network-stats). + +## Tokenomics + + **$WXM** is an ERC20 token to power the weather data economy. + +:::note +WeatherXM is deployed on Arbitrum One Network. You can find the contract at [Arbitrum One Explorer](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6) +::: + +### New approach in crowdsourcing weather data +WeatherXM creates an entirely new weather data economy that rewards the people who deploy and maintain weather stations. +$WXM is currently implemented in [Arbitrum One](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6) as an ERC20 token. + +Like most networks, the value of our Network is greater than the sum of its parts. Station owners are rewarded with $WXM tokens (governance participation) based on the data they contribute on a daily basis. + +To implement this logic, we introduce a smart contract that distributes a fixed budget of tokens (the \$WXM token) to station owners and other stakeholders daily. Any customer who wants to use the Network’s data or services will have to acquire \$WXM. + +### $WXM Token Distribution + +**Total supply of the $WXM token is 100M (100,000,000) tokens.** + +#### 55% - Station Rewards: +Tokens will be used for station owners rewards. 3M of this amount will be used to gradually reward beta users. + +#### 30% - Initial Supporters: +30M tokens will be allocated to initial supporters of the project. These tokens will be locked and they will be unlocked during a period of four (4) years, linearly with one year cliff. + +#### 10% - Treasury +10M tokens will be allocated to the DAO treasury to support the WeatherXM ecosystem development. Tokens will be unlocked linearly during a 5 year period, starting from the day of the token launch. + +#### 5% - Liquidity support: +5M tokens will be provided to token exchanges as a way to allow other interested parties to join the WeatherXM ecosystem governance and/or license data. + +#### 3% Beta Rewards: +3 million tokens will be used to reward stations that contributed data to the Network during the beta phase. This is not a marketing activity intended to create buzz and awareness, but a reward mechanism for the stations that participated and formed the Network before a reward mechanism was in place. + +More specifically, the 3,000,000 tokens will be allocated to stations based on the percentage of rewardable station-hours each station provided to the Network. + +A rewardable station hour is an hour during which the station sent at least one valid weather data package to the network. Proof-of-Location (PoL) is not taken into account during the calculation of the Beta Rewards. + +This provides an additional incentive for the early Network adopters to remain in the network, maximising their station data value due to seniority and providing additional incentive for early members to actively participate in future Network governance. + +:::note +To understand better the "Beta rewards" you can read the related blog post [here](https://blog.weatherxm.com/beta-user-rewards-b2e27b1727d7). +::: + +### Token Emissions + +**Distributed over the next 10 years** + +WeatherXM is a long-term project. The total supply of 100M $WXM tokens is unlocked and distributed based on a predefined 10-year schedule. + +The token distribution is designed to incentivise station owners to provide data to the Network and to reward early supporters of the project. + +All tokens will be minted on token launch. More specifically: +- 52M tokens will be distributed to station owners every day for providing data to the Network. +- 30M tokens will be allocated to initial supporters of the project +- 3M tokens will be distributed to station owners that participated in the Network during its beta phase. See more at [Reward Boosts](/rewards/reward-boosts.mdx) +- 10M tokens are reserved in the Association's treasury. They will be used to support the WeatherXM ecosystem development. +- A one-off issuance of 5M tokens will take place on token launch. These tokens will be used to provide market liquidity. + +### Locked tokens +- **Treasury** tokens will be locked and they will be unlocked linearly during a 5 year period, starting from the day of the token launch. +- **Initial Supporters** tokens will be locked and they will be unlocked linearly during a four (4) year period with one (1) year cliff. + +:::tip +You can always read more at the [WeatherXM Network](https://weatherxm.network/) website. +::: + +--- +# Weather And Science +Canonical: https://docs.weatherxm.com/weather-and-science +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science.md + +## Weather And Science at WeatherXM + +Welcome to the **Weather And Science** section — a hub for our scientific work, technical studies, and exploratory projects in meteorology and atmospheric science. +Here you’ll find **peer-reviewed papers, whitepapers, technical reports, and experimental findings** from the WeatherXM team and our collaborators. + +Our research spans multiple domains, including: +- **Hyperlocal Weather Data** — methods for collecting, validating, and analysing data from our global network of weather stations. +- **Forecasting & Modelling** — blending traditional meteorological models with machine learning techniques to improve prediction accuracy. +- **Climate & Environmental Insights** — studying long-term patterns, microclimates, and the effects of extreme weather events. +- **Web3 & Weather Data Economics** — exploring decentralised data marketplaces, tokenised incentives, and the future of open-access meteorology. + +By publishing our findings openly, we aim to: +- Contribute to **global scientific understanding** of weather and climate. +- Support **innovation in open-source meteorology**. +- Empower developers, researchers, and enthusiasts to **build on our work**. + +Whether you’re a scientist, a developer, or simply curious about how technology can transform weather science — you’ll find something here to explore, learn from, and use. + +--- +# Decompensation of WS2000 temperature offset +Canonical: https://docs.weatherxm.com/weather-and-science/decompensating-ws2000-temperature-offset +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/decompensating-ws2000-temperature-offset.md + +Dr. Stavros Keppas, 30/10/23 - WeatherXM AG + +## 1. Introduction to the issue +In the period February-August 2023 as the duration of daylight was gradually increasing together with the temperature, we observed larger and larger differences in temperature between WS2000 and FosHK WS69 (Figure 1). In particular, the temperature of WS2000 was constantly lower, exclusively during the day, compared to FosHK WS69. The results of our previous analysis showed that WS2000 temperature (TWS2000) was systematically decreased (compared to FosHK WS69) under certain temperature and illuminance regimes. As we additionally compared FosHK WS69 with Davis VP2 weather station, we concluded that WS2000 was eventually underestimated temperature during a typical summer day in mid-latitude areas. This issue needs to be addressed for increasing the reliability and accuracy of WS2000, but also for rehabilitating the uniformity of measurements over the WeatherXM network. + + + + + **Figure 1**. The FosHK WS69 and WS2000 weather station models that were used for data analysis. + + +Our speculation was confirmed by the manufacturer, who provided a ruleset that is followed for decreasing temperature under certain temperature, illuminance and wind speed thresholds (**Table 1**). + + + + **Table 1**. The initial correction algorithm thresholds. + + +## 2. Data and methodology +### a. The Datasets +We employed 8 FosHK WS69/WS2000 couples of weather stations located in three different cities (in Greece and Texas, US) in urban and suburban areas. In each of the couples, both FosHK WS69 and WS2000 are deployed under same conditions (e.g., on a same-height metallic mast within a distance of a few metres). For the analysis, we used temperature, illuminance and wind speed data from the period February-August 2023. We highlight that +WS2000 provides data in 3-minute timesteps, while FosHK WS69 in 16-seconds timesteps. For this reason, the FosHK WS69 data were averaged in 3-minute intervals. + +### b. The Simple De-Compensation +In order to reverse the result of the algorithm shown in Table 1, we applied the recommended corrections shown in Table 2. However, we should highlight here that the upper temperature threshold in each of the classes should be adjusted as a function of the temperature correction of the next class. As an illustration, the first class should be between 25.5-30°C, the second between 30-34.5°C and in case of wind speed <1m/s it should be 30-34°C. However, in the present analysis we examine the recommended algorithm shown in **Table 2**. + + + + **Table 2**. Decompensation algorithm thresholds. + + +### c. The Linear-Polynomial Regression (LPR) De-Compensation +As an alternative method, we developed a relationship for temperature correction via the ‘LinearRegression’ tool from the ‘sklearn.linear_model’ module in python. In order to develop the relationship, 5 of the 8 FosHK WS69/WS2000 couples were randomly chosen and used for training the relationship, while the other 3 were used for testing (Table 3). It is noted that we exclusively used data points that correspond to TWS2000 >25.5°C and illuminance>3000Lux. This means that the following methodology is applied only on data that fulfill these criteria. + + + + **Table 3**. Abbreviation names of locations of which the weather station couples were used for testing of the LPR model.. + + +As the decompensation is mostly affected by the initial temperature measured by the WS2000, we developed one main relationship. + +a. For IWS2000 > 13000Lux and 25.5°C < TWS2000 < 35.5°C, equation 1 is applied: + +**Tdecomp = -0.00463155*TWS2000 +1.3758184*TWS2000 -5.950001094966307 (**Equation 1**)** + +Where: +TWS2000 is the WS2000 temperature in °C. +IWS2000 is the WS2000 illuminance in Lux. + +The equation comes with r2 = 0.98 and Mean Square Error (MSE) = 0.15. + +b. For 3000lux < IWS2000 ≤ 10000Lux and TWS2000 ≥ 36°C, equation 2 is applied: + +**Tdecomp = 0.7907*TWS2000 -0.0911 * WSWS2000 +0.00025863*IWS2000 +6.8931 (**Equation 2**)** + +Where: +TWS2000 is the WS2000 temperature in °C, +WSWS2000 is the WS2000 wind speed in m/s, +IWS2000 is the WS2000 illuminance in Lux. + +Considering that TWS2000 is always below or equal to the true temperature (e.g. as measured by WS69) and in order to avoid any unreasonable extrapolation of this relationship, we cut off any cases that Tdecomp - TWS2000 <0°C setting finally Tdecomp = TWS2000. We also keep always Tdecomp - TWS2000 <1.5°C and <2°C when WSWS2000 is <1m/s and ≤1m/s respectively. + +The equation comes with r2 = 0.71 and MSE = 0.17. + +c. For IWS2000>13000lux and TWS2000>36°C that we are certain about the process: + - For WS>1m/s: + Tdecomp = TWS2000 + 1.5°C (**Equation 3**) + - For WS≤1m/s: + Tdecomp = TWS2000 + 2°C (**Equation 4**) + +To avoid any steep and unrealistic changes in temperature on the application boundaries of the above equations, we suggest a simple transition between the WS2000 temperature and the Tdecomp. + +a. We allow a transition when 24.5°C < TWS2000 ≤ 25.5°C and IWS2000 > 13000Lux: + + Tdecomp = (1 - Tweight)*TWS2000 + Tweight * Equation1 (**Equation 5**) + + Where: + Tweight = (TWS2000 - 24.5) + +b. For the transitional area of illuminance when 24.5°C < TWS2000 ≤ 25.5°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - Iweight)*TWS2000 + Iweight*((1 - Tweight) * TWS2000 + Tweight * Equation1) (Equation 6) + + Where: + Iweight = (IWS2000 - 3000)/10000 + +c. And also for the case that 25.5°C < TWS2000 ≤ 35.5°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - IWS2000)*TWS2000 + IWS2000 * Equation1 (**Equation 7**) + +d. In case that 35.5°C < TWS2000 ≤ 36°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - Iweight)*TWS2000 + Iweight * Equation1 (**Equation 8**) + + When 35.5°C < TWS2000 ≤ 36°C and IWS2000 > 13000Lux - for WSWS2000>1m/s + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation3 + + - for WSWS2000 ≤ 1m/s +Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation4 +Where: +Tweight_up = (TWS2000 - 35.5) / 0.5 + +e. When 35.5°C < TWS2000 ≤ 36°C and IWS2000 > 13000Lux - for WSWS2000>1m/s + + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation3 (**Equation 9**) + + - for WSWS2000 ≤ 1m/s + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation4 (**Equation 10**) + + Where: + Tweight_up = (TWS2000 - 35.5) / 0.5 + +f. When TWS2000>36°C and 10000Lux < IWS2000 ≤ 13000Lux: - for WSWS2000>1m/s + + Tdecomp = (1 - Iweight_up)*Equation2 + Iweight_up*Equation3 (**Equation 11**) + + - for WSWS2000 ≤ 1m/s + Tdecomp = (1 - Iweight_up)*Equation2 + Iweight_up*Equation4 (**Equation 12**) + + Where: + Equation2 is the temperature arising from the Equation 2, but always keeping Tdecomp - TWS2000 between 0-1.5°C or 0-2°C for WSWS2000 >1m/s and ≤1m/s respectively as previously described. + + For the python script of this approach see **Appendix A**. For detailed information regarding the rationale behind selecting this set of equations, see **Appendix B**. Finally, a broad range of values of the involved parameters was used for testing various combinations and edge cases. This analysis is described in **Appendix C**. + +## 3. Results +Here, we compare the temperature time series of a WS69 station (which we consider as reference) with temperature time series from WS2000 (without any decompensation), Simple Decompensation and LPR decompensation in order to choose the most accurate approach of temperature decompensation. +Firstly, we present some problematic cases (mentioned in **Appendix B**) to have a detailed look at the behaviour of each of the approaches. + + - On 16/7/2023 (at SE_1 location) (**Figure 2**) that WS2000 temperatures during the day were fluctuating around 30-32°C, it can be noticed that the Simple Decompensation provides an increased variation, when WS2000 fluctuates around 30.5°C (which is one of the compensation thresholds - see **Table 1**). The LPR method offers a more realistic reconstruction of the temperature, which is usually closer to WS69 temperature. Indeed, LPR decompensation temperature RMSE is lower by 0.19°C and Tmax difference from WS69 is lower by 0.2°C compared to Simple Decompensation method. Certainly, the compensated WS2000 temperature seems to be way off the WS69 temperature. + + + + **Figure 2**. Temperature on 16/07/2023 recorded by TS_1 WS69 (black), WS2000 (red) weather stations. The WS69 is considered as the reference. The Simple Decompensation (yellow) and LPR approaches are also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux. RMSESimple_Decomp = 0.72°C, TmaxSimple_Decomp = 32.3°C, RMSELPR = 0.53°C, TmaxLPR=32.6°C, TmaxLWS69R = 32.9°C. + + + - On 23/7/2023 (at TS_1 location) (**Figure 3**), it is noticed a sudden increase (~2°C) in WS2000 temperature under illuminance values of 3000-13000Lux (at 16-18UTC time), while WS69 temperature gradually decreases. An intense fluctuation (~2°C) is also observed in simple decompansation temperature. The LPR method seems to provide a more realistic representation of the temperature with an ~1°C increase and a much smoother fluctuation. Again, RMSE is lower for the LPR method and maximum temperature of the day is closer to that of WS69. Similarly, in **Figure 4**, where temperature is shown during a hot day (19/8/2023) in one of the stations (Texas, US) used for the training of the LPR approach, the fluctuation of LPR method (at 23-00UTC time) seems to be more realistic with less (in number) fluctuations compared to the Simple Decompensation approach. Although, in this case we exhibit results coming from a couple of weather stations used for training purposes, we aim to highlight the behaviour of the approaches over such high temperatures (that were observed only in this couple of stations). + + + + **Figure 3**. Same as in figure 2 for 23/7/2023. RMSESimple_Decomp = 0.7°C, TmaxSimple_Decomp = 39.4°C, RMSELPR = 0.6°C, TmaxLPR=39.4°C, TmaxWS69 = 39.8°C. + + + + + **Figure 4**. Same as in figure 2 for 19/8/2023. The location of the station couple is situated at Texas (US) and the stations were used for training of LPR. RMSESimple_Decomp = 0.66°C, TmaxSimple_Decomp = 42.7°C, RMSELPR = 0.6°C, TmaxLPR=42.7°C, TmaxWS69 = 42.2°C. + + +Our next step towards the evaluation of the two decompensation methods is to examine the entire warm period (May-August 2023) of TS_1, TS_2 and TS_3. Data before May 2023 were excluded in order to remove any noise in our results, as there are no significant issues for temperatures <26°C. It should be noted again that WS69 temperature was used for reference. As shown in **Table 4**, the compensated WS2000 temperature always exhibits the higher RMSE, MAE and the lower R2. In contrast, the LPR method produces the lowest RMSE and MAE (0.57°C and 0.21°C respectively) together with the impressive R2=0.99. The simple decompensation, although it partly fixes the temperature issue, is still worse than LPR result. + + + + **Table 4**. Root Mean Squared Error (RMSE), Mean Absolute Error (MAE) and R2 between WS69 temperature and WS2000, Simple Decompensation and LPR temperature for the warm period 05-08/2023 for each of the locations SE_1, SE_2 and SE_3. The average of these locations for these statistical metrics is shown in the row ‘Avg’. The scores in this table have been generated using only rows of data where WS69 temperature was <25.5°C. + + +Then, we wanted to investigate the differences in Tmax and Tavg to show the significance of the issue (**Table 5**). The initial compensated WS2000 daily maximum temperature (Tmax) presented ~1.2°C deviation from WS69 temperature. While the simple decompensation dropped this difference to 0.3°C by the simple decompensation, the LPR eliminated this difference (0°C). Regarding the Tavg, the differences are lower (as temperatures <25.5°C are involved in the calculations). However, both Simple Decompensation and LPR eliminate the difference from WS69. + + + + **Table 5**. Average Tmax for the period May-August 2023 for the 3 test locations (SE_1, SE_2, SE_3) as observed by WS69 and WS2000 and calculated by Simple Decompensation and LPR methods. The last row of the table shows the average difference in daily Tmax and Tavg between WS69 and one of the WS2000, Simple Decompensation and LPR temperature time series. + + +We also investigated the difference between average temperatures (including only data rows with WS69 temperature <25.5°C) and the corresponding standard deviations (**Table 6, Figure 5**) for each of the test locations (**Table 3**). It seems that the WS2000 compensated temperature differs by 0.63-0.72°C, the simple decompensation temperature differs by 0.14-0.45°C and the LPR temperature by -0.1 to 0.11°C. In addition, WS2000 exhibits the largest standard deviation (0.65-0.72°C) and the simple decompensation lower standard deviations (0.37-0.45°C). However, the LPR temperature presents the lowest standard deviation (0.32-0.41°C). These results imply that LPR average temperature (for WS69 temperatures <25.5°C) is closer to WS69 temperature than the simple decompensation. Furthermore, it seems that the LPR method demonstrates the lowest variation of temperature differences from WS69. + + + + **Figure 5**. Summarisation of the results of Table 6. Markers indicate the average difference of mean temperature between WS69 and WS2000, simple decompensation and LPR methods (for WS69 temperature <25.5°C), while the error bars depict the corresponding standard deviation. + + +## 4. Conclusions +In this report, we employed 8 couples of WS69/WS2000 weather stations to compare and test decompensation methods for fixing the temperature issue that we detected in a previous report considering as reference (or ground truth) the temperature received from WS69. As we detected serious issues when we applied the Simple Decompensation algorithm, we decided to develop a linear-polynomial regression (LPR) model to efficiently decompensate temperature differences, finding the trends and patterns of such differences. We used 5 couples for training our model, while the rest 3 were used for testing purposes. We finally concluded that the LPR model: + - Do not enhance the temperature variations, when WS2000 temperature fluctuates around the thresholds used for the initial temperature compensation. Instead, LPR produces a much smoother and realistic result. + - Produces smoother and realistic temperature variations before the sunset of a warm day smoothing the unreasonable and sudden temperature increase of WS2000. + - Comes with the lowest RMSE (0.6°C) and MAE (0.23°C) and with the impressively highest R2 (0.99). + - Eliminates the significant temperature differences between WS2000 and WS69. + - Provides the lowest average difference from WS69 for temperatures <25.5°C (-0.1 to 0.11°C) and the most limited variation of the differences with a standard deviation of 0.33-0.41°C. + +Hence, we highly recommend that the LPR method should be applied on raw temperature observations of WS2000 in order to fix this temperature issue and restore the uniformity of our weather station network. + +## Appendix A +The LPR method code has been written in the following python script. Note that the inputs for the temperature calculation are illuminance (lux) in Lux, wind speed (wind) in m/s and temperature (temp) in °C as recorded by WS2000. The algorithm should be applied on every single sampling interval. + +Below is your function, **formatted as valid Python** and wrapped in an MDX code block so you can literally copy-paste it into your `.mdx` file. + +> ⚠️ Because the code came mangled from the PDF (things like `return ... elif ...` on the same line, missing newlines etc.), I’ve reconstructed the indentation and line breaks so it is real Python. Please double-check the logic against your original source. + +δηλαδή να φαίνεται το ```python κλπ σαν κείμενο, τότε χρειάζεσαι nested fences: +**έξω 4 backticks (mdx), μέσα 3 backticks (python)**. + +Βάλε αυτό στο `.mdx` σου: + +```mdx +```python +def linear_regression(lux, wind, temp): + # For the temperature area between 25.5 and 35.5 + if temp > 25.5 and temp < 35.5 and lux > 13000: + return 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + + elif temp > 25.5 and temp < 35.5 and lux > 3000 and lux <= 13000: + weight = (lux - 3000) / 10000 + return (1 - weight) * temp + weight * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + # For the transitional temperature area between 24.5 and 25.5 + elif temp > 24.5 and temp <= 25.5 and lux > 13000: + weight = (temp - 24.5) / 1.0 + return (1 - weight) * temp + weight * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + elif temp > 24.5 and temp <= 25.5 and lux > 3000 and lux <= 13000: + weight_lux = (lux - 3000) / 10000 + weight_temp = temp - 24.5 + return (1 - weight_lux) * temp + weight_lux * ( + (1 - weight_temp) * temp + + weight_temp + * (1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307) + ) + + # For the transitional temperature area between 35.5 and 36 + elif temp >= 35.5 and temp < 36 and lux > 3000 and lux <= 13000: + weight_lux = (lux - 3000) / 10000 + return (1 - weight_lux) * temp + weight_lux * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + elif temp >= 35.5 and temp < 36 and lux > 13000: + weight = (temp - 35.5) / 0.5 + if wind <= 1: + return (1 - weight) * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + weight * (temp + 2) + else: + return (1 - weight) * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + weight * (temp + 1.5) + + # For the temperature area >= 36°C + elif temp >= 36 and lux > 13000: + if wind <= 1: + return temp + 2 + else: + return temp + 1.5 + + elif temp >= 36 and lux > 3000 and lux <= 10000: + temp1 = 0.7907 * temp - 0.0911 * wind + 0.00025863 * lux + 6.8931 + + if temp1 - temp < 0: + temp1 = temp + elif temp1 - temp > 2 and wind <= 1: + temp1 = temp + 2 + elif temp1 - temp > 1.5 and wind > 1: + temp1 = temp + 1.5 + + return temp1 + + elif temp >= 36 and lux > 10000 and lux <= 13000: + temp1 = 0.7907 * temp - 0.0911 * wind + 0.00025863 * lux + 6.8931 + + if temp1 - temp < 0: + temp1 = temp + elif temp1 - temp > 2 and wind <= 1: + temp1 = temp + 2 + elif temp1 - temp > 1.5 and wind > 1: + temp1 = temp + 1.5 + + weight = (lux - 10000) / 3000 + + if wind <= 1: + return (1 - weight) * temp1 + weight * (temp + 2) + else: + return (1 - weight) * temp1 + weight * (temp + 1.5) + + else: + return temp +``` + +## Appendix B +In this section we highlight the reasons that led us to train and develop a linear-polynomial model for decompensating the TWS2000. The basic issues that make the simple decompensation method problematic are: + - The simple decompensation method applies a fixed offset to temperature values within specific temperature ranges, without considering whether the TWS2000 has previously undergone correction as per the process and thresholds outlined in **Table 1**. Consequently, there is uncertainty surrounding the accuracy of temperature observations. For instance, a temperature reading of 25.6°C may not definitively represent 25.6°C, as it might have originally been 26.1°C before undergoing compensation. + - We found that TWS2000 increases significantly when illuminance is around 8000Lux. Although **Table 1** recommends changes in temperature only when illuminance is >8000Lux, it seems that there are cases where temperature steeply increases under slightly higher illuminance for unknown reasons that need further investigation. In particular, in **Figure 6**, TWS2000 is 40°C around 00:00UTC and although TWS2000 and TWS69 are getting close (as it usually occurs for illuminances <8000Lux), in fact illuminance is still >8000Lux, which causes an unreasonable temperature peak when applying the simple decompensation method. + - When TWS2000 fluctuates around one of the compensation boundaries (see **Table 1**) (e.g., around 30.5°C), the decompensation process tends to amplify these fluctuations. This amplification results in unrealistic variations in temperature, causing the readings to appear artificially elevated and then sharply reduced, leading to inaccuracies in the recorded temperature values (**Figure 7**). + + + + **Figure 6**. Temperature on 09/08/2023 recorded WS69 (black), WS2000 (red) weather stations in Texas (US). The WS69 is considered as the reference. The Simple Decompensation (yellow) is also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux + + + + + **Figure 7**. Temperature on 16/07/2023 recorded by TS_1 WS69 (black), WS2000 (red) weather stations. The WS69 is considered as the reference. The Simple Decompensation (yellow) is also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux + + +## Appendix C +To ensure that there are no undesirable results of the LPR method in extreme cases, we plotted several graphs to test it among the ranges of temperature illuminance and wind speed provided by the WS2000 manufacturer, which are -40≤TWS2000≤80°C, 0≤IWS2000≤200000Lux and 0≤WSWS2000≤50m/s. Figures 7-9 show that the difference TLPR-TWS2000 remains always ≥0°C, but also does not exceed 2°C in cases where any case. + +--- +# Obstacle Impact on Temperature and Wind +Canonical: https://docs.weatherxm.com/weather-and-science/obstacle-impact-on-temp-and-wind +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/obstacle-impact-on-temp-and-wind.md + +# Obstacle Impact on Temperature and Wind +Dr. Stavros keppas, 12/08/2025 + +We installed two weather stations on a rooftop to investigate how nearby walls and other obstacles might affect weather measurements. One station, our reference station (considered the reliable installation, see **Figure 1, Station A** - WS1000), was placed at the highest point of the roof, where there were no obstacles taller than the station that could interfere with its readings. The second station, the “obstructed” installation in our experiment (see **Figure 1, Station B** - WS1001), was placed in a location (see Figure 3) where: + +- To the east, a wall 3 m taller than the station is located 5 m away (instead of 21–30 m as suggested by ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- To the west-northwest, a small structure at a similar height as the station, with solar water heaters adding 2 m in height, is located ~5 m away (instead of 21-30m that it should according to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- To the northwest, a triangular wall 2 m taller stands 8–9 m away. +- The south-southwest horizon is relatively open (instead of 21-30m that it should be according to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- The southern horizon is completely open without obstacles. + +For the data analysis, we used **air temperature, wind speed and direction, and solar irradiance**. +- For temperature, we used summer data (10/05/2025–10/08/2025), when urban surfaces are more thermally stressed. +- For wind, we used a longer time series (10/11/2024–10/08/2025) to provide a larger sample. + + ![Experimental setup](image) + + **Figure 1**. The experimental setup with the two stations. Station A is used as a reference and free-of-obstacles + station, while station B is used as the problematic and to-be-investigated station that is surrounded by + significant obstacles. + + +## Temperature Impact + +Regarding temperature, although the wind sample is not evenly distributed across all directions (due to the local climatology, some wind directions occur more or less frequently), there appears to be a pattern that can be explained by the station’s surroundings. More specifically (**Figure 2**): + +- The largest positive temperature differences (with the 90th percentile of biases ranging from 0.34°C to 0.99 °C) are observed when the wind blows from directions where there is an obstacle (thus from north, northeast, east, southwest, west, and northwest). +- Qualitatively, the graphs suggest that the largest positive deviations usually occur when the sun is positioned in the southern or southwestern part of the sky (solar azimuth). At this solar azimuth, the incident solar radiation on the east-facing wall is at or near its maximum, resulting in the greatest potential heating of the surface. +- For winds from the south and southeast, the temperature differences are usually negative or close to zero (−0.92 °C to -0.13 °C). + +This behaviour could be explained by the fact that when wind is blocked by an obstacle, the heat stored in the wall is not dispersed by air circulation, so the air on the sheltered side of the wall warms up more. On the other hand, when wind flows towards the obstacle, it removes heat from the surface, and the nearby air becomes cooler. + +The frequently negative differences in these cases may be due either to differences between the sensors or to the fact that south of Station B there is no concrete (as it is located at the edge of a five-storey building), while south of Station A there are concrete rooftop surfaces that emit some heat. To explain this case a bit deeper, air tends to acquire the thermodynamic properties of the surface it passes over. Although the short distance involved would normally limit significant changes in these properties, in low wind conditions air can theoretically remain over a surface for longer and acquire new thermal characteristics. It should again be emphasised that the unequal sample sizes for each wind direction may reduce the confidence of these conclusions. + + ![Experimental setup](image) + + **Figure 2**. Relationship between temperature measured by station A (Obstacle Free) and station B (Wall Obstacle) for + grouped wind directions. The markers are coloured by the solar azimuth. The median, 10th–90th percentile and the + number of the considered sample is shown in the in-plot frames. For the analysis only data coinciding with + Illuminance >5000Lux (40W/m2) were used to investigate the impact of solar radiation heating on + measurements. The data were aggregated in 10-min intervals to securely identify the wind direction. + + +## Wind Impact + +The effects of obstacles on wind measurements are much more distinct and easier to interpret. The obstacles around Station B (**Figure 3**) are clearly reflected in the wind rose (**Figure 4**): + +- Average wind speeds from the north through to the east-southeast sector (0-135°) are significantly lower at Station B (by up to >1.5 m/s), especially from the east-northeast direction, where the main wall is located. +- In the east-southeast directions, wind speed at Station B tends to recover slightly but still remains lower. This is likely because the wall continues to have some influence on the overall air circulation and flow. Additionally, when winds are from the east, their actual direction may fluctuate between NE and SE, but the measured speed remains reduced due to friction with obstacles and because both wind speed and direction have been averaged over one-minute intervals. +- In the west to west-northwest sector (225-292.5°), although the obstacles there appear less substantial, they still have a significant effect, reducing speeds by up to 1 m/s. +- The absence of obstacles to the south is clearly visible: for winds from the south-southeast to southwest sector, average wind speeds are comparable between both stations. +- Obstacles to the north and north-northwest appear to have a smaller impact on measurement quality, likely because they are further away and not continuous, with openings through which air can occasionally pass. +- Overall, Station B consistently records lower average wind speeds, even from directions where the horizon is free of obstacles. This is likely because it is installed closer to the rooftop surface, where friction between the air and surfaces is stronger (**Figure 5a**). Additionally, for southerly winds, the airflow approaching the building may be deflected upward upon encountering the structure, reducing the speed recorded by the station (**Figure 5b**). + + ![Experimental setup](image) + + **Figure 3**. The surrounding area of station B. The free-of-obstacle, partly blocked and blocked directions are indicated + by green, orange and red lines together with the pointing direction. + + + ![Experimental setup](image) + + **Figure 4**. Wind rose showing the average wind speed per cardinal direction for Station A (Obstacle Free) and Station B + (Wall Obstacle). 10-min wind averages were used for the plot. + + + ![Experimental setup](image) + + **Figure 5**. Qualitative and simplistic schemes of air flow and wind speed (a) above a horizontal surface + ([NASA](https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/boundlay.html)) and (b) a building + ([AIVC.org](https://www.aivc.org/sites/default/files/airbase_866.pdf); [WMO](https://library.wmo.int/viewer/68661/?offset=31#page=501&viewer=picture&o=bookmark&n=0&q=)). + +--- +# Quality Mechanisms +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms.md + +# Quality Mechanisms + +In this section, all the available quality mechanisms are fully described. + +## Contents + +- [**General QoD Description (OBC-SQC, ISD, SPV)**](/weather-and-science/quality-mechanisms/general-qod-description): General and brief description of all the available quality mechanisms. +- [**Indoors Station Detector (ISD)**](/weather-and-science/quality-mechanisms/isd-full-documentation): Full documentation of the Indoors Station Detector (ISD), which is the mechanism that detects stations placed indoors, but also some other problematic situations. +- [**OBC and SQC Annotations**](/weather-and-science/quality-mechanisms/obc-sqc-annotations): Description of the annotations produced by the OBC-SQC quality mechanism. +- [**Out-of-Bounds (OBC) and Self Quality Checks (SQC)**](/weather-and-science/quality-mechanisms/obc-sqc-documentation): Full documentation of the Out-of-Bounds Check (OBC) and Self-Quality-Check (SQC) mechanism, which focuses on the detection of suspicious data in the transmitted raw data. +- [**OBC and SQC Score Calculation**](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation): The method of the final daily OBC-SQC score calculation. +- [**Station Photo Verification (SPV)**](/weather-and-science/quality-mechanisms/spv-full-documentation): Full documentation of the Station Photo Verification (SPV) mechanism, which aims to evaluate the station deployments via photos. + +--- +# SQC - Constancy Analysis Report +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/constancy-analysis-report +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/constancy-analysis-report.md + +# Constancy Analysis Report +Dr. Stavros Keppas, 21/09/2023 + +One of the sub-processes within the Self-Quality-Check (SQC) of the Quality of Data (QoD) mechanism involves the examination of data to identify instances where it appears suspiciously unchanging for extended durations. According to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)) guidelines, constant temperature, relative humidity (RH), wind, and pressure data, should be flagged as suspicious if they remain constant for longer than one hour, with the exception of RH, which applies only when it exceeds 95%. + +## 1. Data and Method + +To ensure that we tailor these criteria to match the specifications of WeatherXM’s weather stations and to flag not suspicious but actually erroneous data, we utilised up to one year of data (09/2022 to 09/ 2023, where available) from 18 well-deployed weather stations at various locations (coastal, continental, lowland, hilly at various latitudes) (**Figure 1**). This extensive dataset allowed us to assess the constancy of key parameters, namely temperature, RH, and wind speed, which are prone to remaining unchanged for prolonged periods. + + ![Experimental setup](image) + + **Figure 1**. Locations of the weather stations used for the constancy analysis. + + +The datasets were averaged over 1 minute intervals, which corresponds to the "ignoring period" (during which we populate empty rows with data to facilitate Quality of Data processes - see [QoD documentation section 1](/weather-and-science/quality-mechanisms/obc-sqc-documentation#1-filling-ignoring-period---filling-no-data-slots)) chosen in the Quality of Data (QoD) mechanism. Then, we determined the duration of time during which consecutive observations remained at a certain value. + +## 2. results + +Here, we examine the patterns and correlations among three parameters (temperature, RH and wind speed), when they exhibit prolonged periods of constancy. The objective of this analysis is to identify meteorological conditions that may explain why a parameter remains constant for extended hours. Conversely, it inevitably seeks to highlight conditions that are less conducive to the persistence of constant values over extended periods. + +The analysis reveals that temperature tends to remain constant for relatively brief periods, typically less than 100 minutes (**Figure 2**). Nevertheless, there were instances where the duration exceeded 200 minutes, coinciding with RH levels surpassing 95%. Therefore, it is advisable to establish a conservative threshold for constancy duration, setting it at 240 minutes, while median RH does not exceed 95%. + + ![Experimental setup](image) + + **Figure 2**. Duration of constant temperature (in minutes) versus median wind speed for the period of constancy. + The scatter points are coloured based on the median relative humidity observed during the same constancy period. + + +RH exhibits a capacity to remain constant for significantly longer durations compared to temperature (**Figure 3**). In certain instances, RH can remain constant for over 2000 minutes. However, when examining constancy durations exceeding 305 minutes, it becomes evident that the median RH was consistently ≥95%. Therefore, it is advisable to establish a constancy threshold of 360 minutes for cases where the median RH is <95%. + + + + **Figure 3**. Duration of constant relative humidity (in minutes) versus median temperature for the period of constancy. + The scatter points are coloured based on the median relative humidity observed during the same constancy period. + +--- +# General QoD Description (OBC-SQC, ISD, SPV) +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/general-qod-description +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/general-qod-description.md + +# General QoD Description (OBC-SQC, ISD, SPV) + +At the moment, there are three data quality mechanisms being applied at WeatherXM. These mechanisms are designed to assess both the quality of the data itself and the status of the station deployments. Each mechanism follows a different approach to evaluate the reliability of a station’s data, and they ultimately work complementarily, contributing to a more comprehensive evaluation of each station. Although the final result of these data quality mechanisms affects user rewards, their primary objectives are: +- To determine which stations produce data reliable enough to be used internally by the company, as well as by third-party companies and organizations as a product. +- To motivate users to improve their deployments, aiming for the highest possible measurement quality. +- To ensure that the data is of high enough quality to be used for improving the weather forecasts that WeatherXM produces at station locations. + +Currently, the following three data quality mechanisms are used to classify and assess stations and their data: +- Out-of-Bounds Check (OBC) and Self Quality Check (SQC) +- Indoors Station Detector (ISD) +- Station Photo Verification (SPV) + +## Out-of-Bounds Check (OBC) and Self Quality Check (SQC) + +Both OBC and SQC aim to detect suspicious data at the raw, minute, and hourly level. This means that these mechanisms can identify unusual variations in different station parameters caused by faulty deployments or malfunctioning sensors, when such variations occur and when the prevailing meteorological conditions allow them to be detected. + +For example, a sudden temperature change caused by using a very short mast that keeps the station too close to the surface of a rooftop will be detected primarily on a calm day with alternating sunshine and cloud cover. Under such conditions, the station will record very abrupt temperature changes; otherwise, detection would not be possible. + +OBC and SQC therefore flag specific raw data points that appear suspicious (they do not label an entire deployment as problematic). These two mechanisms run within a unified algorithm every day, assessing the data from the previous day. The checks performed are as follows: + +**A. Out-of-Bounds Check** +OBC is a simple process that involves identifying values that fall outside the specifications set by the manufacturer for each sensor. As an example, if the temperature sensor is able to measure within a temperature range of -60 to 60°C, then the value 80°C is considered as faulty. + +**B. Self Quality Check (SQC)** +This mechanism uses the data from the station itself (and therefore does not rely on third-party data for comparison) to detect unexpected changes in various parameters, which may be due either to poor placement of the weather station or to a malfunction in one of its sensors. + +The checks performed are: +- **Check for stagnation** (lack of variability) in the parameters. For example, a constant recording of zero wind speed and an unchanging wind direction for six hours, combined with low relative humidity, is an indication that the station is located in a place where air circulation is not as expected, or that the anemometer has frozen (if the temperature has been >0°C for several hours). +- **Check for suspicious spikes** over short time intervals, which may occur either due to poor station placement or because of a faulty sensor. For example, a temperature change >3°C within 1 minute is considered unrealistic. If the station’s sampling interval is greater than 1 minute, the respective threshold is increased linearly, provided that the sampling rate remains below 10 minutes. +- **Check for gaps in the data**. Each station model, according to its specifications, is capable of sending data packets at a specific time interval. If the number of packets received on an hourly basis is lower than the threshold set by the specifications, this indicates a problem in data transmission (e.g., poor 4G/Wi-Fi/Helium signal). + +Similar checks (for stagnation and spikes), but with different time windows (based on WMO –[Guide to the Global Observing System (WMO-No. 488), pg.200](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)– guidelines as well as our [own data analysis](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)), are carried out for all parameters (see [full documentation](/weather-and-science/quality-mechanisms/obc-sqc-documentation)). + +Finally, the ratio of invalid to expected valid data is calculated on an hourly basis in order to determine the final score of successful meteorological observations. + +## Indoors Station Detector (ISD) + +The ISD is a mechanism primarily aimed at identifying stations that are active but have not been placed outdoors. However, there is a range of other classifications that can be assigned to a station’s deployment status. The ISD mechanism runs once per day and evaluates the data from the entire previous day, but for the final evaluation result it also takes into account the outcomes from the last seven days in order to provide a fairer classification of the station’s deployment. The key difference compared to OBC-SQC is that ISD evaluates the entire day as a whole, assigning a single annotation related to the station’s deployment status. + +For deployment assessment, the ISD uses solar radiation analysis techniques, comparing actual measurements with theoretical radiation values for each location on the planet and for each day of the year. In parallel, various combined thresholds are applied to temperature, wind direction/speed, and relative humidity (thresholds derived from exploratory data analysis) in order to identify certain significantly problematic deployment cases. It should be noted, however, that ISD is able to detect only a small subset of problematic deployments, as its main focus is on identifying stations that are located indoors. The classifications resulting from the ISD mechanism are shown in Table 1. See full [ISD documentation here](/weather-and-science/quality-mechanisms/isd-full-documentation). + +Table 1. ISD annotations, their short description, and their impact on the quality score. +Note that the short description is statistically derived, and the actual status of the station may differ. + +| ISD Annotation | Short Description | Impact on Score | +|----------------------------|-----------------------------------------------------------------------------------|-----------------| +| OUTDOORS | Well deployed | NO | +| INDOORS | In a house or a very closed area | YES | +| ALMOST INDOORS | In a closed area e.g., a balcony | YES | +| BAD DEPLOYMENT | In an area surrounded by significant obstacles | YES | +| PROBABLY BAD DEPLOYMENT | In an area that has some obstacles that may affect mainly wind, precipitation and solar irradiance observations | YES | +| INCLINED POLE NORTH | On a north-tilted pole or the light sensor needs cleaning | YES | +| INCLINED POLE EAST | On an east-tilted pole | YES | +| INCLINED POLE SOUTH | On a south-tilted pole | YES | +| INCLINED POLE WEST | On a west-tilted pole | YES | +| PROBLEMATIC LIGHT SENSOR | Weird spikes in solar irradiance | NO | +| REPLACE ILLUMINANCE | Solar irradiance is always 0 | YES | +| ALMOST NIGHT | The station is located in a high-latitude region that experiences darkness during the winter months, with little to no sunlight | NO | +| INDOORS FROZEN | The station looks like indoors due to freezing conditions | NO | +| INDOORS ALMOST FROZEN | The station looks like indoors almost due to freezing conditions | NO | +| BAD DEPLOYMENT FROZEN | The station looks like bad deployment due to freezing conditions | NO | +| PROBABLY DEPLOYMENT FROZEN | The station looks like probably bad deployment due to freezing conditions | NO | +| UNKNOWN | Less than 40% of the expected data during the period of the day with solar irradiance >0.1 W m−2 | NO | + +## Station Photo Verification (SPV) + +At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO) (see also [our obstacle experiment](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx)). The SPV mechanism evaluates the deployment of each station as depicted in the photos submitted by the user through the mobile app. Through SPV, seven key aspects of the photos are examined in order to assess both the overall deployment and the extent to which each parameter can be measured accurately. This mechanism assigns a score to the station each time the user submits a set of photos, which is then evaluated internally by company staff. The 7 aspects and how they affect the SPV score are described in Table 2. Each aspect is assessed separately based on the condition shown in the photo under evaluation, unless an issue is identified that affects the station’s measurements regardless of orientation. Each photo receives a score for each of the 5 aspects that can be scored, and then the average score per photo is calculated. Finally, the average score of the 4 photos (one for each cardinal direction) is computed, which determines the final SPV score. It should be noted that if there is no photo for a specific cardinal direction, the score for that direction is considered to be zero. The SPV scoring rules and guidelines are comprehensively described in [this document](/weather-and-science/quality-mechanisms/spv-full-documentation). + +Table 2. The SPV aspects, their short description and the available score options. + +| SPV Aspect | Short Description | Score Options | +|------------------------------|-----------------------------------------------------------------------------------|---------------| +| Photo Validity | Evaluation of whether the photo meets the standards set by the company | 0, 0.5, 1 | +| Temperature/Relative Humidity| Evaluation of the validity of the temperature and relative humidity measurements | 0, 0.5, 1 | +| Wind | Evaluation of the validity of the wind measurements | 0, 0.5, 1 | +| Precipitation | Evaluation of the validity of the precipitation measurements | 0, 0.5, 1 | +| Solar Irradiance | Evaluation of the validity of the solar irradiance measurements | 0, 0.5, 1 | +| Mast Height | Evaluation of the relative mast height in relation to the objects in the surrounding area | - | +| Mast Inclination | Classification of a visibly tilted mast toward a specific direction | - | + +--- +# Indoors Station Detector (ISD) +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/isd-full-documentation +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/isd-full-documentation.md + +# Indoor Station Detector (ISD) + +## 1. Introduction + +Indoors Station Detector (ISD) is a component of the Quality of Data (QoD) mechanism that is responsible for scoring the quality of the weather data and the deployment of the weather stations. + +The ISD is a component of the Self Check process (meaning that it exclusively relies on data from the weather station and does not utilise data from third-party sources). Originally, ISD is designed to identify, and eventually characterise, weather stations that are deployed indoors (i.e., inside houses, boxes, closets, etc.), which is reflected in its name. While being designed, ISD has evolved to also detect stations located in enclosed areas (e.g., balconies), places with significant obstacles, and on tilted poles. + +The ISD primarily relies on the parameter of solar irradiance. Therefore, without sufficient data of this parameter, ISD cannot make a decision about a station's deployment. Although the main comparison is between observed and theoretical solar irradiance, the analysis of wind, temperature, and relative humidity (RH) variances contribute significantly to the final decision. The final outcome of the ISD component is a characterisation of the weather station's deployment, which is provided daily and reflects the variations in the collected weather measurements. This characterisation can be used to determine whether specific parameters can be trusted. It’s important to note that atmospheric pressure measurements are valid, even when a weather station is located indoors. + +## 2. ISD Categories + +While the ISD was initially designed to identify only indoor stations, the experimentation with solar irradiance measurements has enhanced its capabilities, enabling it to detect a wider range of problematic cases and categories. These include: + + 1. Outdoors + 2. Indoors + 3. Indoors Almost + 4. Bad Deployment + 5. Probably Bad Deployment + 6. Inclined Pole North + 7. Inclined Pole East + 8. Inclined Pole South + 9. Inclined Pole West + 10. Problematic light sensor + 11. Replace Illuminance + 12. Almost Night + 13. Indoors Frozen + 14. Indoors Almost Frozen + 15. Bad Deployment Frozen + 16. Probably Bad Deployment Frozen + 17. Unknown + 18. No firmware version + +In the next paragraphs there is a comprehensive explanation of the 17 different ISD categories. + +a. **OUTDOORS**. A station of the “OUTDOORS” category should observe a significant amount of solar irradiance through the day, and reasonable variations in temperature, RH, wind speed and wind direction (**Figure 1**). + + + + **Figure 1**. Temperature (blue) and Relative Humidity (green), Observed (light red) and Theoretical (dark red) Solar Irradiance, wind speed and wind direction of a station fell into the “OUTDOORS” category on 24/4/2024. + + +b. **INDOORS**. These stations are identified as being placed indoors (within a house, etc.) or in highly enclosed areas with significant obstacles that strongly affect the weather observations. This determination is based on the observation of low solar irradiance, as well as unreasonably low variations in wind speed/direction, temperature, and relative humidity, which are not expected in an open area environment (**Figure 2**). Consequently, the reliability of all observed variables from these stations is highly questionable. + + + + **Figure 2**. Same as Figure 1, but for a weather station that fell into the “INDOORS” category. + + +c. **INDOORS_ALMOST**. This category includes stations that seem to have reasonable variations in temperature and relative humidity through the day. However, even these two parameters may have a significant offset from the ground truth. Even if temperature and humidity looks reasonable, the reliability of the remaining observed variables from these stations is highly questionable (Figure 3). Such stations are considered to be in very closed areas (such as balconies or indoors next to an open window etc). Although this category is similar to the ‘INDOORS’, it actually indicates the probability that a station is surrounded by ‘fresh air’. + + + + **Figure 3**. Same as Figure 1, but for a weather station that fell into the “INDOORS ALMOST” category. + + +d. **BAD_DEPLOYMENT**. In this category, stations appear to be poorly deployed. As an illustration, a station can typically be surrounded by significant obstacles that may affect not only the sensitive-to-obstacles parameters like wind and precipitation, but also temperature and humidity. It is highly likely that solar irradiance remains at unreasonably low levels throughout the day, with wind speed and direction exhibiting low variations, and even prolonged periods of calm conditions (**Figure 4**). If any data from these stations were to be utilised, it would only be for the parameters of temperature and relative humidity. However, even the reliability of these parameters remains uncertain. + + + + **Figure 4**. Same as Figure 1, but for a weather station that fell into the “BAD DEPLOYMENT” category. + + +e. **PROBABLY_BAD_DEPLOYMENT**. In this category, the weather stations do not always measure the expected variations in their measurements indicating that the deployment may be poor and some significant obstacles around may prevent from recording reliable measurements. Temperature and relative humidity readings should be used cautiously. Precipitation and wind speed/direction data may be unreliable, particularly when air flows from certain but (at the moment) unspecified directions. Solar irradiance readings are also not reliable. In general, any issues with the station would be mostly evident in the parameters related to solar irradiance and wind (**Figure 5**). The distinction from the "BAD_DEPLOYMENT" category lies in the deployment’s capacity to record higher solar irradiance throughout the day. + + + + **Figure 5**. Same as Figure 1, but for a weather station that fell into the “PROBABLY BAD DEPLOYMENT” category. + + +f. **INCLINED_POLE_***. Stations in this category are positioned on tilted poles. To account for the various tilt directions, there are four distinct categories, each identified by a letter at the end (N, E, S, W) that indicates the direction in which the pole is tilted relative to the horizon. In the specific case where a station falls into the ‘INCLINED_N’ category, this could be attributed to either a tilted pole or a dusty light sensor. A weather station can be classified into one of these categories only on cloudless days, when we can obtain a well-defined bell-shaped solar irradiance curve time series for comparison with the theoretical curve. Classification is not feasible on overcast or partly cloudy days (**Appendix A1 - Figure 11**). + +g. **PROBLEMATIC_LIGHT_SENSOR**. Within this classification, the recorded solar irradiance consistently registers at 0W/m2. This may occur due to a faulty sensor, the presence of snow or other thick materials covering the sensor, or prolonged night in high latitudes during the winter. Although a constancy check is implemented in QoD v1 components, instances where solar irradiance remained consistently at 0 W m−2 were excluded. This exclusion arose from the uncertainty regarding whether the stations are located in areas that experience near-continuous nighttime for 24 hours each day. This ambiguity can now be addressed in ISD by comparing the data with theoretical solar irradiance. Since such faulty solar irradiance measurements cannot assist in taking any decisions under these circumstances, these stations are excluded from the ISD process. +In this category, stations constantly report a solar irradiance of 0W/m2, a behaviour that cannot be explained by the theoretical solar irradiance (**Figure 6**). Although our analysis did not reveal any stations with unusual variations in temperature, relative humidity, or wind speed/direction, as the time series data from these stations cannot undergo the ISD process, there remains the possibility that these stations may be unreliable. + + + + **Figure 6**. Same as Figure 1, but for a weather station that fell into the “PROBLEMATIC ILLUMINANCE” category. + + +h. **REPLACE_ILLUMINANCE**. In this category, observed solar illuminance exhibits irrational spikes, usually out-of-bounds. Such solar irradiance measurements are not valid and these stations are excluded from the ISD process. Such issues may also be detected by QoD v1.0, allowing for the results from the different QoD components (Out-Of-Bounds -OBC-, Self Quality Check -SQC- and ISD) to be cross-verified. + + + + **Figure 7**. Same as Figure 1, but for a weather station on 10/10/2023 that fell into the “REPLACE ILLUMINANCE” category. + + +i. **ALMOST_NIGHT**. There is no way to determine the condition of a deployment through the ISD when the daily mean solar irradiance is <5 W m−2 (**Figure 8**), as the solar irradiance signatures we seek cannot be detected under these conditions. Stations located in high latitudes are typically expected to measure very low temperatures or may even be completely frozen. This category is used to distinguish between stations that are located in artificially dark conditions and those that are affected by physically prolonged dark conditions. + + + + **Figure 8**. Same as Figure 1, but for a weather station on 21/11/2024 that fell into the “ALMOST NIGHT” category. + + +j. ***_FROZEN**. If a station falls into one of the categories ‘INDOORS’, ‘INDOORS_ALMOST’, ‘BAD_DEPLOYMENT’, or ‘PROBABLY_BAD_DEPLOYMENT’, and the **(TMD)** is <0.5°C, then this station is reclassified into the same category but with the suffix ‘_FROZEN’. This method aims to exclude potential false positives caused by frozen sensors, such as low solar irradiance readings from a light sensor covered by snow. + +k. **UNKNOWN**. Stations that provide less than 40% of the expected data packets, during the period that solar altitude is greater than 7°, fall into this category. This occurs because the solar curve cannot be adequately represented, making it difficult to determine whether any significant obstacles are present near the station (**Figure 9**). + + + + **Figure 9**. Same as Figure 1, but for a weather station that fell into the “UNKNOWN” category. + + +l. **NO FIRMWARE VERSION**. If the firmware version is missing, it becomes unclear whether the solar irradiance value has been corrected. An uncorrected solar irradiance value is multiplied by 10, which could cause the ISD to mistakenly classify the deployment as faulty. However, this is an annotation for internal use only and it does not affect user's rewards. + +## 3. The Method + +### 3.1 Parameters + +The method is primarily based on solar irradiance measurements in order to compare them with the [theoretical solar irradiance](/weather-and-science/r&d/theoretical-solar-radiation.mdx) for a given location and day (Nijegorodov, 1996; Ahmad and Tiwari, 2011). The theoretical solar irradiance algorithm returns the following parameters: + +a. (SIthe): the diurnal theoretical solar irradiance under clear sky conditions (W/m2) +SIthe is one of the most important parameters for ISD and it is produced for every single location, day of the year and hour of a day. It is the reference parameter for evaluating how reasonable the levels and the variations of the **observed solar irradiance** are throughout the day. Typically the observed solar irradiance (SIobs) is lower than the theoretical. Nevertheless, during a partly cloudy day, solar irradiance spikes may significantly exceed the theoretical curve due to the “Cloud Enhancement” phenomenon caused by the Mie Scattering effect (Jarvela et al., 2020). + +b. **SA (Solar Altitude)**: the angular elevation of the center of the solar disk above the horizontal plane (degrees) +SA is useful for filtering the observations of a station, when solar measurements are too low to be usable. + +After: a. cleaning (SIthe) and (SIobs) from NaNs, b keeping only the solar data corresponding to SA >7° in order to exclude the near-zero/zero values and c. keeping only the solar data for which (SIthe) >0.1(W/m2) and (SIobs) is not NaN, we derive the following solar irradiance dependent parameters: +- **Daily average ratio between (SIthe) and (SIthe) ((RatioSIOT_daily))** (which ranges between 0 and >1). In properly deployed weather stations, the expected value is typically &ht;1. However, very low values, such as <0.05, raise concerns and suggest that the weather station may not be properly deployed. Very high values (e.g., >1.5) suggest a probably faulty light sensor. +- **Daily average of SI_the (SIthe_daily_avg)** (W/m2). Days with average SI_the <5W/m2 are considered as days that ISD cannot effectively detect problematic deployments. +- **Daily maximum of SI_the (SIthe_daily_max)** (W/m2) +It is used indirectly to calculate thresholds of statistical metrics (like residual standard error and correlation coefficient of solar irradiance measurements - see parameters i and j) to determine some of the criteria that a station falls into a problematic class. +- **Count ratio between observed and theoretical solar irradiance (CRSI_OT)**, which is the ratio between the number of the non-nan SIobs and the number of the SIthe when SIthe > 0 W/m2 +This is one of the most important parameters that makes the first filtering. Weather stations that observe 0 W/m2 for long periods through a day, while the theoretical solar irradiance suggests values > 0W/m2 are considered as suspicious. +- **Standard Deviation of of observed SI_obs (SIobs_sd)** (W/m2) +It is a good indicator for distinguishing between problematic deployments with low solar irradiance (low variance of solar irradiance due to significant obstacles or indoors placement) and non-problematic ones during overcast (larger variance of solar irradiance as the thickness of clouds varies through a day allowing less or more light to reach the light sensor) +- **Percentage of NaN SI_obs elements (PSI_ON_AN)** (%) versus the total number of the SI_obs elements +This is a simple ratio that indicates the availability of observations. To make decisions based on solar irradiance data, we need to have a sufficient amount of data. Therefore, we set the availability threshold at 40%. +- **Correlation coefficient** between observed and theoretical solar irradiance (**ccOT**) +This metric is utilised in the calculations for the inclination criterion. High values of this metric indicate a strong similarity between theoretical and observed solar irradiance, which typically occurs in a well-deployed station on a cloudless day. +- **Residual Standard Error (RSE)** between the observed solar irradiance measurements and the polynomial fit of 5th order on them (W/m2) +RSE is valuable for identifying completely cloudless days, which can help in detecting tilted masts. Low RSE indicates small deviations of the SIobs from the polynomial fit, which is characteristic of cloudless days. +- **Correlation coefficient threshold (ccOT_thres)** +It is empirically calculated and ranges between 0.990 and 0.995 for a corresponding SIthe_daily_max range of 400 to 700 W/m2. The relationship between the two is cubic. +- **RSE threshold (RSEthres)** (W/m2) +It is empirically calculated and ranges between 5 and 50 for a corresponding SIthe_daily_max range of 5 to 1000 W/m2. The relationship between the two is quartic. +- **Inclination criterion**, which consists of two sub-parameters, the **inclination** (Inclined/Normal) and the **inclination orientation** (N/E/S/W) +This parameter indicates whether the pole is tilted (inclination) and the direction of the tilt (inclination orientation). + +We also clean from NaNs and use the parameters of **temperature, RH, wind speed and wind direction** to support the ISD analysis. +We then calculate the following metrics based on the non-solar parameters mentioned above: +- **Temperature standard deviation (TSD)** (°C) It has been observed that low temperature variations, in the absence of increased humidity throughout the day, indicate that a weather station is situated in a confined area where airflow is minimal or non-existent. +- **Temperature daily median (TMD)** (%) (considering all 24-hour temperature observations) It is used to determine if a day was too cold for the sensors to freeze. The threshold below which there is a likelihood of the sensors freezing is set at 0.5°C. +- **RH standard deviation (RHSD)** (%) It has been observed that low RH variations, in the absence of increased humidity throughout the day, indicate that a weather station is situated in a confined area where airflow is minimal or non-existent. +- **RH daily median (RHMD)** (%) (considering only RH observations when solar altitude >7°) It is used to define a day as wet to assist in the investigation of parameter variance. Under wet conditions (e.g., relative humidity > 85%), temperature, relative humidity, wind, and solar irradiance may show minimal variations over time. +- **Variance of the differences of the consecutive RH observations (RHvar_diff)** (%) (considering only RH observations when solar altitude >7°) It is the variance of the differences between consecutive RH measurements. This metric is used to differentiate between ‘INDOORS’ and ‘INDOORS_ALMOST’. Weather stations that may have some potential for outdoor deployment, while most parameters suggest that they are positioned indoors, often exhibit greater fluctuations in relative humidity (RH). +- **Wind speed standard deviation (WSPDSD)** (m/s) It is a reasonable assumption that small variances in wind speed throughout the day, combined with low variances in other parameters under relatively dry conditions, may indicate a problematic deployment (dry conditions are associated with sunny days, which result in differential evaporation and heating over surfaces, eventually leading to the formation of air flows). While a weather station placed indoors should ideally show zero variations in wind speed, there may be sources of airflow (e.g., windows, cooling or heating systems) that can introduce some variation. Therefore, we establish low but not zero thresholds to filter out poorly deployed stations. +- **Wind speed constancy index** (True/False) This index is considered true when the most frequently observed wind speed occurs for more than 50% of the day. It is highly unlikely for a constant wind speed (usually at 0 m/s) to persist for half of the day. Additionally, when paired with low solar irradiance or a low RHMD (thus in relatively dry conditions), this situation suggests a criterion for poorly deployed stations. +- **Wind direction circular variance** (°) (after converting degrees into radians) We use circular variance for wind direction since it is a circular parameter. A significant lack of variance in wind direction can support the assumption that a weather station is poorly deployed. +- **Wind direction constancy index** (True/False) This index is True when the most common wind direction observation appears in more than 50% of the day. It is used similarly to Wind speed constancy index. + +### 3.2 Algorithm + +The mechanism consists of a complex if-then-else structure that was developed based on exploratory data analysis (EDA), utilizing a set of reasonable assumptions and criteria that were gradually confirmed through the EDA process. Although the algorithm is publicly available, we will present the main groups of criteria used to characterise the deployment condition of a weather station. + +The first filtering drops the stations into 3 main ‘buckets’ which are: + + a. Stations with valid data for decision-making (PSI_ON_AN > 40% and SIthe_daily_avg > 5W/m2) + b. Stations located in geographical areas (high latitudes during winter) where sunlight is insufficient throughout the day to detect any patterns and, eventually, make decisions (PSI_ON_AN > 40% and SIthe_daily_avg ≤ 5W/m2). These stations fall into the ‘ALMOST_NIGHT’ category. + c. Stations with inadequate data due to significant data loss during the day (PSI_ON_AN ≤ 40%). These stations fall into the ‘UNKNOWN’ category. + +Therefore, the first of the three aforementioned categories includes all the stations that have sufficient data and sunlight, allowing us to identify any deployment issues. Following the initial filtering, the stations that provide enough data fall into the next three categories: + + a. **CRSI_OT = 0** These stations are unable to observe any sunlight during the day, indicating that they are likely placed indoors. However, if some variation in wind speed is observed, it may suggest that the stations are located in an area with numerous significant obstacles nearby (e.g., deployed on a balcony or under a roof etc.). However, if all the other parameters variate as expected, then the light sensor may be problematic. + + b. **0% < CRSI_OT <40%** Such stations still register unexpectedly low sunlight during the day, suggesting that the station may be positioned indoors (where some sunlight might pass through windows) or could be poorly deployed (with sunlight significantly blocked by obstacles). To differentiate between an indoor station and a poorly deployed station, we utilize a series of criteria that evaluate the variability of temperature, RH, and wind. For example, a station that experiences low sunlight along with low variations in temperature, RH, and wind speed/direction, under a regime of RHMD <85%, is considered to be indoors. + + c. **CRSI_OT < 40%** This category can lead to almost any of the ISD classifications through a complex set of empirical criteria. To ensure that we focus only on the problematic cases, we utilise **RatioSIOT_daily**, specifically investigating cases with a ratio of <0.2. Additionally, we examine the variations in temperature, RH and wind to determine if a station is surrounded by significant obstacles. The variability of solar irradiance further assists in understanding whether physical variations occur throughout the day. In addition, we apply the inclination criterion (**Appendix A1**) using a threshold of <1.5 for the **RatioSIOT_daily**. + +As expected, stations with low **CRSI_OT** and/or low **RatioSIOT_daily** are classified into one of the problematic categories rather than the OUTDOORS category (**Figure 10**). + + + + **Figure 10**. Observed-to-theoretical solar irradiance ratio versus the count ratio, categorised by the five basic ISD categories. To enhance the readability of the graph, very few stations with extremely high or low count ratios and/or observed-to-theoretical solar irradiance ratios have been excluded from the presentation.. + + +### 3.3 Final Aggregator + +The ISD mechanism evaluates the previous day’s data on a daily basis and produces one result per station, per day. There are various reasons why a station’s ISD result may vary from day to day (e.g., the statistical nature of the algorithm, environmental conditions to which the station is exposed, etc.). For this reason, the ISD Aggregator takes into account the results from the last seven days to assign the final classification of each station’s deployment. + +To decide on a unique ISD annotation that determines the final Quality of Deployment (QoD) score, the ISD Aggregator considers the results of the last 7 days for each station. To determine this unique annotation, the algorithm considers the following criteria: + + a. Dominant ISD Annotation: The annotation that characterises the deployment of a meteorological station is the one that appears most frequently within the 7-day period. + + b. Tie-Breaker Criteria: If two or more annotations are equally frequent within the 7-day period, the dominant annotation is determined by its assigned weight (see **Table 1**). The weight reflects both the significance of an annotation and the algorithm’s strategy to assign greater importance to more problematic annotations (e.g., Indoors) over less problematic ones (e.g., Probably Bad Deployment). + + c. Insufficient Data: If 50.1% of the days (in this case, 4 out of 7 days) lack sufficient data, a decision cannot be made for the station. In this scenario, the dominant annotation is marked as UNKNOWN. This implies that for newly claimed stations, users must wait at least 4 days to receive an ISD annotation from the aggregator. + +Table 1. ISD Annotations, their weight of significance and their ISD score. + + + ISD Annotation + Weight + Score + + + OUTDOORS61 + INDOORS100 + ALMOST INDOORS90 + BAD DEPLOYMENT80.29 + PROBABLY BAD DEPLOYMENT70.43 + INCLINED POLE NORTH50.86 + INCLINED POLE EAST50.86 + INCLINED POLE SOUTH50.86 + INCLINED POLE WEST50.86 + PROBLEMATIC LIGHT SENSOR40.86 + REPLACE ILLUMINANCE30.86 + ALMOST NIGHT11 + INDOORS FROZEN21 + INDOORS ALMOST FROZEN21 + BAD DEPLOYMENT FROZEN21 + PROBABLY DEPLOYMENT FROZEN21 + UNKNOWN11 + +### 3.4 Final ISD Score + +The final score assigned to a station is directly related to its deployment classification from the ISD and is shown in **Table 1**. It should be noted, however, that this score is used by another algorithm (called the Unifier), which combines the scores from the individual quality mechanisms to produce the station’s final daily quality score. + +## 4. Limitations + +It's important to note that the ISD is a blind method, meaning it was developed without having many stations with known deployment status to initially validate the technique. Instead, it relied on a series of logical assumptions and criteria based on exploratory data analysis. Practical validation of ISD results is not always feasible, as deployment status can ultimately only be confirmed through photographs. However, the final version of the algorithm was evaluated on a small sample of test weather stations. Generally, there is a high degree of confidence that only problematic deployments are classified into the ISD’s problematic categories. The ISD criteria were intentionally designed to be as stringent as possible to detect exclusively problematic cases in order to avoid false positives. This strictness implies that some problematic deployments may go undetected by this mechanism. Additionally, a station can shift between categories from day to day based on weather conditions (e.g., strong winds, sunny days in winter or summer, etc.). + +Below, we outline some limitations encountered during our data analysis: + 1. **ISD mainly aims to detect “INDOORS” stations. Some poorly deployed weather stations may also be detected. However, future QoD components will be able to detect more efficiently poorly deployed stations.** + 2. Numerous poorly deployed weather stations might be classified as "OUTDOORS." This situation can result from significant fluctuations in solar irradiance due to a temporary unobstructed line of sight between the station and the sun. As a result, the light sensor may record the anticipated levels of solar irradiance and its variations for a few hours during the day. For example, this can occur even in the case of a weather station located next to an open window. + 3. Weather stations located indoors, where the user has ensured adequate sunlight and occasional airflow toward the station (such as through an open window, a fan, or an air conditioner), may be misclassified. Although it is very likely that such a station will fall into one of the problematic categories, the classification may not be accurate. + 4. Distinguishing between “PROBABLY_BAD_DEPLOYMENT” and “BAD_DEPLOYMENT” is not always an easy task. Depending on the dominant weather conditions (e.g. cloudless or dark foggy weather) a “BAD_DEPLOYMENT” weather station may fall into the “PROBABLY_BAD_DEPLOYMENT” or vice versa. + 5. Stations that fall into the categories “REPLACE_ILLUMINANCE”, “PROBLEMATIC_ILLUMINANCE”, “ALMOST_NIGHT” and “UNKNOWN” may be poorly deployed, but it is impossible to categorise them through this process. + +## Appendix + +### A1. Inclination Criterion + +This set of criteria assists in detecting tilted masts on which stations are deployed. Note that tilted masts can only be detected on completely cloudless days. To achieve this, we check the **ccOT** and **RSE** to understand the degree of similarity between observed and theoretical solar irradiance curves. In general, we search for high **ccOT** (>0.8), low **RSE (< RSEthres)** and **RHMD** <85% for the period of the day that solar altitude is >7° (to ensure that at least the lower troposphere is fairly clear). This cloudless condition is essential for detecting any inclinations of the pole. + +The process of detecting north-south tilted poles is different from this for detecting east-west tilted poles. + +To identify a north-tilted pole, we apply a straightforward criterion. The criterion is that the **RatioSIOT_daily** should be between 0.3 - 0.67 when the cloudless condition is met. This indicates that a station measures significantly lower solar irradiance than expected during a cloudless day. In contrast, a station on a south-tilted pole is characterised by **RatioSIOT_daily** between 1.05 and 1.4. This indicates that a station measures significantly higher solar irradiance than expected during a cloudless day. Ratios <0.3 are typically observed at poorly deployed stations that do not have direct exposure to sunlight, while ratios <1.4 are indicative of problems with the light sensor. + +On the other hand, to identify east/west-tilted poles, we use a more complex approach, summarised in the following steps: + + - Firstly, the **RatioSIOT_daily** should be <0.9, as SIobs can be significantly lower for extended periods during the day when the pole is tilted to the east or west. It is important to note that **SIobs** should naturally be consistently slightly lower than the **SIthe** curve on a cloudless day. + - Next, the daily time series of the solar irradiance ratio between observed and theoretical values should be divided into four segments of equal time length. + - If the **RatioSIOT_daily** of the fourth segment is >0.9 and the difference between the fourth and the first segment is >0.4, then the pole is tilted to the west. + - If the **RatioSIOT_daily** of the first segment is >0.9 and the difference between the fourth and the first segment is <0.4, then the pole is tilted to the east. + + + + **Figure 11**. Theoretical (dark red) and observed (light red) solar irradiance of cloudless days as estimated/measured by a station on a. south tilted, b. north tilted, c. west tilted and d. East tilted pole. + + +## References + +Ahmad, M. J., & Tiwari, G. N. (2011). Solar radiation models—A review. *International Journal of Energy Research, 35(4)*, 271-290. + +Järvelä, M., Lappalainen, K., & Valkealahti, S. (2020). Characteristics of the cloud enhancement phenomenon and PV power plants. *Solar Energy*, 196, 137-145. + +Nijegorodov, N. (1996). Improved ASHRAE model to predict hourly and daily solar radiation components in Botswana, Namibia, and Zimbabwe. *Renewable energy*, 9(1-4), 1270-1273. + +--- +# OBC and SQC Annotations +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-annotations +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-annotations.md + +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) Annotations + +The QoD algorithm produces annotation codes associated with various weather parameters to provide a detailed description of a specific condition for each parameter. These codes serve as a standard format of communication between the various services that use them and they will be mapped to user-friendly messages on the clients. + +## Parameters under Investigation + +The following is a table of all parameters characterized by QoD. + +Table – Parameters considered in the analysis + + + + Parameter + Index + + + + + Temperature + 1 + + + Humidity + 2 + + + Wind speed + 3 + + + Wind direction + 4 + + + Pressure + 5 + + + Illuminance + 6 + + + Accumulated precipitation + 7 + + + +## Hourly Level Annotation + +Table – List of annotations and their definitions + + + + Annotation + Annotation code + Derives from level + Applies to + Description + Version + + + + + OBC + OBC + Raw + All parameters + Values out of bounds, related to the sensor’s spec. Faulty sensor or firmware. + 1.0.0 + + + Raw spikes + SPIKE_INST + Raw + All except precipitation and wind direction + Two consecutive values vary more than physically possible. Faulty sensor or bad deployment. + 1.0.0 + + + No median + NO_MEDIAN + Raw + All except precipitation and wind direction + Not enough data points to infer the median value of the aggregated time window. Connection issues (internet or Helium network). Useful also to identify the reason for spikes. + <=1.0.2 + + + Unidentified spikes + UNIDENTIFIED_SPIKE + Raw + All except precipitation and wind direction + Two consecutive values vary more than physically possible, but not enough data points to infer the median and identify which values are erroneous. Faulty sensor or bad deployment. + >=1.0.4 + + + N/A data + NO_DATA + Raw + All parameters + No data in the aggregated time window. Connection issues (internet or Helium network). + 1.0.0 + + + Short Constant + SHORT_CONST + Raw + All except precipitation + Value not changed in the aggregated time window, shorter than the entire reference day (e.g. a few hours). Faulty sensor or bad deployment. + 1.0.0 + + + Long Constant + LONG_CONST + Raw + All except humidity, illuminance, precipitation + Value not changed for 24 hours. Faulty sensor or bad deployment. + 1.0.0 + + + Frozen Sensor + FROZEN_SENSOR + Raw + Wind speed and wind direction + Not measuring wind speed, wind direction is constant and temperature below zero. Frozen sensor. + 1.0.0 + + + Minute Spikes + ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Two consecutive minute averages vary more than physically possible. Bad deployment (possible) / Faulty Sensor (less possible). + 1.0.0 + + + Unidentified change + UNIDENTIFIED_ANOMALOUS_CHANGE + Minute + All except precipitation and wind direction + Two consecutive values vary more than physically possible, but not enough data points to infer the median and identify which values are erroneous. Bad deployment (possible) / Faulty Sensor (less possible). + >=1.0.4 + + + +Note that there are two spike annotations. The one arises in raw level and the other in minute level. In order to distinguish between them, we refer to the raw spike annotation as SPIKE_INST and to the minute spike as ANOMALOUS_INCREASE. Thus, SPIKE_INST implies that there was an instant spike in one or more of the data packets that we received and is highly likely to be due to faulty sensor and less (but still) likely to be due to bad deployment. On the other hand, ANOMALOUS_INCREASE implies that there was suspicious change when comparing consecutive minute averages. This could be possibly due to bad deployment (e.g., gradual increase in temperature due to a chimney that started working), but we cannot exclude the case of faulty sensor. +UNIDENTIFIED_SPIKE and UNIDENTIFIED_ANOMALOUS_CHANGE label all values that appear suspicious for spikes or dips, in contrast to "SPIKE_INST" and "ANOMALOUS_INCREASE" annotations, which exclusively label the spike or dip value itself. This implies that the user will receive a different Quality of Data (QoD) score if either of the first two annotations is activated, compared to the two latter annotations. + +--- +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-documentation +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-documentation.md + +# Obstacle Impact on Temperature and Wind + +Data quality serves as the mechanism used to differentiate between accurate and erroneous data recorded by a weather station. To achieve this, we employ a series of techniques and processes that scrutinise different aspects related to data quality. +The current iteration of the Data Quality algorithm incorporates control checks to pinpoint instances where a sensor records values beyond the limits specified by the manufacturer, identifies unusual jumps, recognises constant values, or determines if there is insufficient data to compute an average. + +The processes included in the Data Quality mechanism v1 are divided into two categories: +- Out-of-Bounds Check (OBC) +- Self Quality Check (SQC) + +Data Quality v1 is able to process: +- Time series with an interval <30 seconds (High Temporal Resolution Time series - **HTRT**) +- Time series with a time interval ≥1 minute (Low Temporal Resolution Time series - **LTRT**). We consider that the value provided on this time interval (e.g., 3 minutes) time interval is the outcome derived from the averaging of a sequence of internally recorded measurements. + +The **final output of the Data Quality mechanism** is an hourly **percentage** of valid/available data and the corresponding **text annotations per meteorological variable** (temperature, relative humidity, wind speed, wind direction, atmospheric pressure, illuminance and precipitation). However, there is a [post Data Quality score process](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation) that aggregates all the annotations and scores into a daily output per station. + +Before moving forward to the description of the Data Quality mechanism, we should note that the input data has been standardised over time (resampling). Weather stations may transmit data at varying non-fixed time intervals. This implies that even if a station's specification indicates a recording frequency of 16 seconds, the actual interval can fluctuate, ranging from a few seconds to several minutes. To ensure that the quality control operates on a time-normalised dataset, a new timeframe is established with a fixed interval (determined by the theoretical recording frequency (fr) of the station model, such as 16’’ for the WG1000 - M5 model). + +## 1. Filling Ignoring period - Filling No-Data Slots + +To ensure the proper functioning of certain SQC processes, an ignoring time period is established (**Table 1**). In practice, all time slots within the ignoring period that lack data are filled with the most recent valid value. Subsequently, this newly filled time series is exclusively employed for scrutinising constant data and anomalous jumps at the raw scale level (see **section 3**). + +***Table 1** – Ignoring period for the available weather station models.* +| Weather Station Model | Ignoring Period [seconds] | +|:---------------------:|:-------------------------:| +| WG1000 (M5) | 60 | +| WS2000 (Helium) | 180 | + +## 2. Out-of-Bounds Check (OBC) + +OBC is a simple process aimed at identifying values for each parameter that exceed the limits set by the manufacturer. The OBC proves highly valuable in identifying sensors that might be experiencing technical malfunctions. OBC is a simple check for temperature, relative humidity, wind speed/direction, atmospheric pressure, illuminance and precipitation that stands alone. + +Particularly for the parameter of precipitation, OBC applies to the variable “accumulated precipitation”. As OBC for precipitation looks at the accumulated precipitation difference between two consecutive time steps, it should be applied over the filled time series produced in **section 1**. This allows for a discrimination of faulty precipitation rates, even under the lack of data for a predefined short period of time. The upper cut-off limit used for this process is time dependent, as its default unit is in mm/sec. Thus, this limit is adjusted depending on the recording frequency of the station model (e.g., from 0.254mm/sec to 4.064mm/16sec) and, eventually, the OBC is applied on the difference of the “accumulated precipitation”. In case of a no-data slot that has been filled (according to the process in **section 1**), the precipitation cut-off threshold is reduced to the corresponding time (e.g., for a data temporal resolution of 16’’, if time slots at 16’’, 32’’ and 48’’ have no data and have been filled with the value of the latest valid measurement at 00’’, and the next available measurement is at 64’’, the cut-off limit will gradually increase for each filled time step till the next valid datum, such as 4.064, 8.128, 12.192, 16.256mm). + +Currently, there are two sets of outdoor sensors (WS1000 and WS2000), each accompanied by its own respective specifications outlined in **Tables 2 and 3**. + +***Table 2** - Manufacturer’s limits for WS1000 (M5) sensors.* +| Parameter | Lower Limit | Upper Limit | +|:------------------------:|:-----------:|:-----------:| +| Temperature [°C] | -40 | 60 | +| Relative Humidity [%] | 10 | 99 | +| Wind Direction [°] | 0 | 359 | +| Wind Speed [m/s] | 0 | 50 | +| Atmospheric Pressure [mb]| 300 | 1100 | +| Illuminance [Lux] | 0 | 400000 | +| Precipitation [mm] | 0 | 0.254/sec | + +***Table 3** - Manufacturer’s limits for WS2000 (Helium) sensors.* +| Parameter | Lower Limit | Upper Limit | +|:-------------------------:|:-----------:|:-----------:| +| Temperature [°C] | -40 | 80 | +| Relative Humidity [%] | 1 | 99 | +| Wind Direction [°] | 0 | 359 | +| Wind Speed [m/s] | 0 | 50 | +| Atmospheric Pressure [mb] | 540 | 1100 | +| Illuminance [Lux] | 0 | 200000 | +| Precipitation [mm] | 0 | 0.254/sec | + +## 3. Self Quality Check (SQC) + +SQC is a process that aims to detect anomalous behaviour of weather observations due to faulty sensors or not proper deployments using only the data of a single weather station itself. The thresholds, but also the assumptions that lead to the final result, are based on the ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)) and ([European Commission](https://publications.jrc.ec.europa.eu/repository/handle/JRC128152)) general guidelines. However, our further data analysis based on data from the WeatherXM network results in corrected and less strict thresholds at some SQC checks. + +As there are weather stations that transmit data at various time intervals, ranging from a few seconds to several minutes, SQC should be capable of annotating data regardless of the temporal resolution of a data time series. However, it is important to highlight that temporal resolutions exceeding 1’ may not be suitable for achieving rigorous control checks. + +SQC consists of a series of controls per parameter (temperature, relative humidity, wind speed, wind direction, atmospheric pressure and illuminance) at different time scales, which differ for different temporal resolutions (HTRT, LTRT). Note that precipitation is excluded from SQC, as it requires a careful and more complex quality control. + +A HTRT passes through (**Table 4**): +a. raw scale level control (every single of the raw data is checked for suspicious jumps, unavailable and constant data), +b. minute scale level control (1-minute averaged data are checked for suspicious jumps and unavailable data) +c. hourly scale level control (final counting of invalid/unavailable hourly time slots) + +For LTRT, practically only the raw (which is now called inter-minute scale level) and the hourly scale levels are applied, as the minute averaging is not applicable (**Table 5**). + +*Table 4 - All the control processes that extend across the three time scale levels for the case of a weather station that records data every 30 seconds or less (e.g., WG1000 (M5)).* +| Control Process of HTRTs (<30 sec) | Time Scale | Control Check Type | +|:---------------------------------:|:------------:|:-------------------------------------------:| +| Raw Scale | <30 sec | Constant data detection
Unavailable data detection | +| Minute Scale | 1 minute | Suspicious Jump Detection
Unavailable data detection | +| Hourly Scale | 1 hour | Suspicious Jump Detection
Counting of invalid hourly time slots | + +*Table 5 - All the control processes that extend across the two time scale levels for the case of a weather station that records data every 1 minute or more (e.g., WS2000 (Helium)).* +| Control Process of LTRTs (≥1 min) | Time Scale | Control Check Type | +|:--------------------------------:|:-----------------:|:-------------------------------------------:| +| Inter-Minute Scale | ≥1 min | Constant data detection
Unavailable data detection | +| Hourly Scale | 1 hour | Suspicious Jump Detection
Counting of invalid hourly time slots | + +There are three basic processes to check **Constancy**, **Availability** and **Fluctuation** of the data, these are **a. Constant data detection, b. Unavailable data detection and c. Suspicious jump detection**. + +### a.Constancy Checks +The constant data detection process aims to identify whether a sensor is recording unchanging values due to technical disruptions or improper deployment. This process is applied to raw data to ensure that even insignificant alterations over a span of a few seconds are taken into account. According to WMO recommendations, the parameters of temperature, relative humidity, wind speed, wind direction and atmospheric pressure should not remain constant for more than 1 hour. However, our current approach employs a more flexible strategy, employing different thresholds according to our data analysis ([see the report](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)). +While constant data typically raises suspicion, there are certain cases that warrant exclusion. For instance, during foggy or fairly wet conditions, there is often a prolonged period of constant relative humidity/temperature/wind spanning hours, and thus, such cases are excluded from this process (**Table 6** - Constancy Duration Threshold). Regarding wind speed, constant, but non-zero wind speed under freezing temperatures is considered as faulty (due to faulty sensor). Note that in the particular case of WS2000, constant annotations on wind speed measurements are removed if wind direction comes with no constant annotations (this applies to all types of constant annotations). Regarding illuminance, we establish a maximum threshold for constant illuminance when it is not equal to 0 lux. This is because it may remain at ≠0Lux for extended hours during the night, but it should not remain constant at a specific value for an extended period during the day. +Finally, a second set of constancy checks is established to mainly identify faulty sensors (**Table 6** - Constancy Duration Max Threshold). Consequently, any time series under investigation is marked as erroneous when the data remain constant for 1440 minutes without any additional specific conditions. It is worth noting that relative humidity has been excluded from this criterion due to its potential to remain constant for longer durations (as explained in [the report](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)). In addition, illuminance and pressure are also excluded since the initial set of criteria (with a 120-minute threshold) adequately addresses constancy checks for this parameter. + +Table 6 - Duration thresholds for the constant data detection process. + + + + Variable + Constancy Duration Threshold (minutes) + Constancy Duration Max Threshold (minutes) + Control Checks (annotated as faulty) + Exclusions + + + + + Temperature + 240 + 1440 + Constant values when RHmedian < 95%
Constant values when RHmedian ≥ 95% + – + + + Relative Humidity + 360 + – + Constant values when RHmedian < 95%
Constant values when RHmedian ≥ 95% + – + + + Wind Speed + 360 + 1440 + + Constant wind speed = 0 m/s when Tmedian > 0°C
+ Constant values when Tmedian < 0°C (frozen)
+ Constant wind speed = 0 m/s when RHmedian < 85%
+ Constant wind speed ≠ 0 m/s
+ Constant values when RHmedian ≥ 85% + + – + + + Wind Direction + 360 + 1440 + + Constant wind direction when Tmedian > 0°C
+ Constant wind direction when RHmedian < 85%
+ Constant values when Tmedian ≤ 0°C
+ Constant values when RHmedian ≥ 85% + + – + + + Atmospheric Pressure + 120 + – + Constant pressure regardless of the pressure value + – + + + Illuminance + 120 + – + Constant illuminance when ≠ 0 Lux
Constant illuminance when = 0 Lux + – + + + +### b. Unavailable Data Detection + +Having already resampled the timeframe, we then check for no-data timeslots. We count the no-data time slots at both raw and minute scale levels. Note that in minute scale level, a no-data timeslot may arise due to lack of raw data within a certain minute or invalidity of data (e.g., see **section 3c**). + +In order to be able to produce 1-10min averages (as [WMO](https://library.wmo.int/viewer/35699/?offset=#page=213&viewer=picture&o=search&n=0&q=suspicious) recommends), one valid (which has passed all the previous control checks) data package per minute and one per 3 minutes is required for HTRTs and LTRTs respectively (**Table 7**). Note that in both cases a data package is the result of averaging measurements within that period of time (which coincides with the uplink rate of each weather station e.g., 16’’ and 3’ for WS1000 and WS2000). However, in cases of weather stations at remote places with difficulties in connection and power, even a single data package per hour is still valuable (e.g., comparing with numerical model outputs) and should be scored by the Data Quality mechanism. Finally, no-data slots are counted in the Minute/Inter-Minute level (HTRTs/LTRTs) and the hourly result eventually contributes to the final Data Quality score. + +Table 7 - Maximum and minimum expected (with no penalty) number of data packages per weather station type. + + + + Station Type + Maximum No of Data Packages per Hour + Minimum No of Data Packages with no Penalty + + + + + WS1000 + 225 + 60 (1/minute) + + + WS2000 + 20 + 18 (~1/3minutes) + + + +To generate 1-10 minute averages, a valid data package is required for each minute (for HTRTs) and one every three minutes (for LTRTs). A data package, resulting from averaged measurements within the specified time period, aligns with the uplink rate of each weather station, such as 16’’ and 3’ for WS1000 and WS2000, respectively. It's important to note that, in instances where weather stations face challenges in connectivity and power (e.g., stations on mountain tops), even a single data package per hour holds value (e.g., for comparison with numerical model outputs) and should be assessed by the Data Quality mechanism. Additionally, no-data slots are considered at the Minute/Inter-Minute level (HTRTs/LTRTs), and the hourly outcome ultimately contributes to the final Data Quality score. + +### c. Suspicious Jump Detection + +Suspicious jump detection is employed to detect abrupt and unusual changes in a parameter occurring within a short period of time. Such changes are often attributed to technical disruptions, although in fewer instances, they may result from improper deployment. This process is applied along both raw and minute scale levels for HTRTs (**Table 8**), while it operates solely at the raw data scale for LTRTs (**Table 9**). The LTRTs’ thresholds are applied in a proportional way till the pre-defined upper limit (**Table 9**). For instance, if the temperature jump threshold for a 1-min interval is 3°C, it will be 9°C for a 3-min interval, but will never exceed the upper limit of 15°C. The upper limits are recommended by the European Commission for consecutive 1-hour averaged values. We highlight the lack of RH upper limit prompting us to make an arbitrary yet logical decision to set the value at 80%. In case of a faulty jump detection, an additional check is conducted to label the subsequent value as faulty if it equals the previously identified faulty value. + +To overcome the challenge of distinguishing a faulty value from two consecutive ones, we require a minimum of 67% of the data within the past 10-minute window to calculate the median for HTRTs (60-min window for LTRTs). Subsequently, we compare both the two consecutive values with the calculated median, eventually categorising the one with the largest absolute difference from the median as faulty. The same process applies on both raw and (inter-minute) scale levels. Note that if the median cannot be calculated, then no decision can be taken and the datum is annotated as not available. + +Table 8 - Jump thresholds for the raw and minute scale levels for HTRTs. There are no jump thresholds for wind direction observations. + + + + + Temperature + RH + Wind Spd + Wind Dir + Pressure + Illuminance + + + + + Raw scale level jump threshold + ≤2°C + ≤5% + ≤20m/s + - + ≤0.5mb + ≤97600Lux + + + Minute scale level jump threshold + ≤3°C + ≤10% + ≤10m/s + - + ≤0.8mb + ≤97600Lux + + + +Table 9 - Jump thresholds for the raw and minute scale levels for LTRTs. There are no jump thresholds for wind direction observations. + + + + + Temperature + RH + Wind Speed + Wind Dir + Pressure + Illuminance + + + + + Inter-Minute scale level jump threshold + ≤3°C + ≤10% + ≤10m/s + - + ≤0.8mb + ≤97600Lux + + + Upper Limit + 15°C + 80% + 15m/s + - + 15mb + 146400Lux + + + +### d. Interpreting the Annotations + +At both of the raw and (inter-) minute scale levels various text annotations are assigned to every single value for each of the 7 investigated meteorological variables (**Table 10**). At the hourly scale level, all the unique text annotations produced in the previous levels are gathered to provide information about all the detected faults within the hourly slot. + +Detailed description of the derived annotations can be found here. + +Table 10 - All the possible annotations derived from Data Quality v1 and reach the hourly/daily level. + + + + Annotation Code + Derivation level + Applies to + Process + Description + + + + + 1
OBC + Raw + All parameters + OBC + Value is out of manufacturer’s bounds + + + 2
SPIKE_INST + Raw + All except precipitation and wind direction + Suspicious Jump Detection + Value represents a meteorologically unreasonable spike/dip + + + 3
UNIDENTIFIED SPIKE + Raw + All except precipitation and wind direction + Suspicious Jump Detection + Group of consecutive values with large difference, but not enough data to identify the true spike + + + 4
NO_DATA + Raw + All parameters + Unavailable Data Detection + No data received in the expected timeslot + + + 5
SHORT_CONST + Raw + All except precipitation + Constancy Checks + Parameter remains constant for longer than expected + + + 6
LONG_CONST + Raw + All except humidity, illuminance, precipitation + Constancy Checks + Parameter remains constant for longer than expected + + + 7
FROZEN_SENSOR + Raw + Wind speed and wind direction + Constancy Checks + Parameter remains constant for longer than expected due to low temperatures + + + 8
ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Suspicious Jump Detection + Value represents a meteorologically unreasonable spike/dip + + + 9
UNIDENTIFIED_ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Suspicious Jump Detection + Group of consecutive values with large difference, but not enough data to identify the true spike + +--- +# OBC and SQC Score Calculation +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-score-calculation +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.md + +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) Score Calculation + +QoD v1.0.0 includes three control processes: + a. OBC (Out-of-Bounds Check) + b. SQC (Self-Quality Check) + +The OBC and SQC processes produce hourly scores per weather station, which range between 0-1 depending on the availability of the clear (valid and available) data. Here, we describe the method of converting hourly scores per parameter to a daily score per weather station. + +The Out-of-Bounds (OBC) and Self-Quality Checks (SQC) are the two basic processes that run together to finally: + a. annotate weather data in hourly level depending on their quality, + b. produce a unique daily score and annotations per weather station + +Internally, the OBC and SQC processes look into each of the 7 meteorological parameters (temperature, relative humidity, wind speed, wind direction, pressure, illuminance and precipitation). Precipitation passes only through the OBC process, as it needs more complex techniques to detect faults in such measurements. + +At the end of the OBC/SQC processes, considering that we always check a 24-hour period of data, each meteorological parameter comes with 24 hourly scores (Shourly), which arise from the availability of the clear (valid and available) data and range between 0-1. + +The way from Shourly per parameter to a total daily score (Stotal) per station is described in the following steps: + +Firstly, we calculate the **daily score per parameter** (Sdaily parameter): + +$$ +S_{\text{daily parameter}_{i}} = 1/24 \sum_{j=1}^{24} S_{\text{hourly}_{i,j}} +$$ + +Where: + i has range 1 to 7, as the number of the, under examination, meteorological parameters + j is the hour ranging between 1-24 (or 0-23) + +Finally, the **total daily score** (Stotal) is calculated as follows: + +$$ +S_{\text{total}} = \frac{1}{n} \sum_{i=\text{obc-sqc - 1}}^{n} S_{\text{daily parameter}_{i}} +$$ + +Where: + n is the number of meteorological parameters (for now n=7) + +--- +# Station Photo Verification (SPV) +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/spv-full-documentation.md + +#Station Photo Verification (SPV) Full Documentation + +At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO). This alignment ensures that the data generated by our stations is reliable and can be effectively used across the various use cases our company supports. + +The SPV mechanism serves a dual purpose, just like all quality control processes related to data and deployments at WeatherXM: + a. To document the deployment so that anyone interested in the station’s data knows whether it can be trusted, and + b. To inform the user about the quality of the deployment, with the goal of encouraging and motivating them to improve it as much as possible. + +## 1. The SPV Aspects + +To ensure the process is as objective as possible, we have defined seven distinct annotation categories (hereafter referred to as SPV aspects). One aspect assesses the validity of the photo, four aspects evaluate the potential impact of the deployment on specific sensors, and two additional aspects describe the mast’s properties. + +As mentioned earlier, there are seven SPV aspects to annotate for every single photo of a given station deployment. Since we expect four photos per deployment, one for each of the four points of the horizon (N, E, S, W), each of the seven SPV aspects should be annotated for every photo. This multi-aspect scoring approach allows us to more effectively identify which sensors may be affected by a faulty deployment and to highlight these impacts. + +The SPV aspects, which are shown together with their annotations and scores in **Table 1**, are: + 1. Photo Validity + 2. Mast Height + 3. Mast Inclination + 4. Temperature and RH + 5. Wind + 6. Precipitation + 7. Solar Irradiance + +Note that: + a. Mast height and mast inclination are the 2 aspects that are not scored. + b. Temperature, relative humidity (RH), wind, precipitation, and solar irradiance are the 4 aspects related to the corresponding sensors referred to as **SPV sensor aspects**. + +In addition to the aspects, the reviewer is able to leave comments regarding potential issues that have not been anticipated by the predefined annotation system, as well as suggestions on how the user could improve their deployment. + +Table 1. All the SPV aspects together with their possible annotations (per aspect) and their corresponding scores. + + + + SPV Aspect + Annotations + Score + + + + + photo_validity + valid + 1 + + + partly_valid + 0.5 + + + invalid + 0 + + + mast_height + over + - + + + proper + - + + + mid + - + + + low + - + + + mast_inclination + inclined + - + + + not_inclined + - + + + t_rh + valid + 1 + + + partly_affected + 0.5 + + + biased + 0 + + + wind + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + precipitation + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + solar_irradiance + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + +## 2. The Scoring Process +Once each SPV aspect has been uniquely annotated for each of the 4 photos of the deployment (each for every single point of horizon -N, E, S, W-), the following calculations can be performed to determine the final score for each deployment: + a. Average the scores of the SPV sensor aspects per photo (thus per point of horizon) to get the spv_sensor_average_per_horizon_point + b. Multiply each spv_sensor_average_per_horizon_point by the corresponding photo validity score (per point of horizon) to obtain spv_fnl_per_horizon_point. + c. Average all the elements in spv_fnl_per_horizon_point to obtain the final SPV score of the deployment (spv_total_deployment_score) + +Note that each of the four photos should be annotated for all SPV aspects. However, if the photo_validity aspect is marked as invalid, scoring the remaining SPV aspects is of little significance, since marking a photo as invalid automatically sets its score to zero. + +The following Python script demonstrates how these calculations can be performed: + +```python +import numpy as np +# Each list contains the scores per photo in the order +# [North, East, South, West] + +# Define the photo validity aspect +photo_validity_aspect = np.array([1,1,1,0]) + +# Define a dictionary with all the SPV sensor aspects +spv_sensor_aspects = { + "temperature": np.array([1,1,1,0]), + "rh": np.array([1,1,0.5,0]), + "wind": np.array([1,0.5,0.5,0]), + "precipitation": np.array([1,0.5,0.5,0]), + "solar_irradiance": np.array([np.nan,0,0,0]) +} + +# Get the average between the SPV sensor aspects per index (index = point of horizon) +values_matrix = np.column_stack(list(spv_sensor_aspects.values())) +spv_sensor_average_per_horizon_point = np.nanmean(values_matrix, axis=1) + +# Multiply each horizon point average with the validity score of the photo of the horizon point +spv_fnl_per_horizon_point = photo_validity_aspect * spv_sensor_average_per_horizon_point + +# Averaging the the elements of the spv_fnl_per_horizon_point +spv_total_deployment_score = np.nanmean(spv_fnl_per_horizon_point) +``` + +## 3. General Deployment Guidelines + +To successfully pass all SPV checkpoints, a user must ensure the following: + +**A. Photo Validity** +- Upload four valid landscape-mode photos (one per cardinal direction: North, East, West, South). Note that the eight aspects are evaluated for each cardinal direction separately. +- The station must be visible and centred in each photo. +- Photos should be taken at the station’s level, or (if not possible) from far enough away to capture all nearby features (e.g., trees or buildings, including those behind the station). +- Photos should be taken after installation and show all parts of the station clearly, along with the widest possible view of the surroundings in the direction faced. +- Avoid using portrait mode or zoomed-in images. +- In case taking a photo at a certain point of the horizon is not possible (e.g., because the station is located at the edge of a tall building), it is recommended to use a selfie stick or to take a photo that shows the specific point of the horizon but includes at least part of the mast (if it is only one horizon point that cannot be captured) or part of the station (if more than one horizon points cannot be captured), so that the orientation can be determined. In any case, photos taken in this way must not exceed two. + +**B. Mast Height** +- The station must be mounted on a pole that is at least 2 meters tall. +- It must also be positioned at least 2 meters above any surface below or beside it. +- Ideally, the station should not be shaded by obstacles during the day and should be fully exposed to direct sunlight. + +**C. Mast Inclination** +- The pole must be visibly vertically aligned with respect to sea level. +- The alignment bubble on the station should be used during installation to ensure proper levelling. + +**D. Obstacle Distances per Parameter** +- The station should be located at a distance at least twice the vertical difference between the station and the height of surrounding obstacles to accurately measure temperature and relative humidity. +- The station should be at a distance at least seven times the height difference from surrounding obstacles to accurately measure wind. +- The station should be at a distance at least four times the height difference from surrounding obstacles to accurately measure precipitation. + +**E. Solar Radiation** +- The station should not be shaded during daylight hours by obstacles such as trees, buildings, or antennas. +- There must be direct line-of-sight between the sun and the solar radiation sensor. + +## 4. Practical Examples of Station Evaluation + +### The Perfect Deployment + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------|-------------------------|-------------------------|-------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Proper | Proper | Proper | Proper | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Orientation | North | West | East | South | +| | | | | | + +The weather station is ideally installed. These are the key points: +- It is deployed in an open area, with surrounding obstacles (e.g., buildings) located at a distance at least two/four/seven times the difference in height between the obstacle and the station. This setup eliminates any potential impact on temperature/precipitation/wind measurements +- It is mounted on mast height is appropriate (2–4 meters). +- The user has uploaded one photo per cardinal direction, each providing a wide view of the surrounding environment. + +### Partly Valid Photos and Short Mast + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|----------------------------|-------------------------|----------------------------|-------------------------| +| Photo Validity | Partly Valid (0.5/1) | Invalid (0/1) | Partly Valid (0.5/1) | (0/1) | +| Mast Height | Low | - | Low | - | +| Mast Inclination | Not Inclined | - | Not Inclined | - | +| Temperature and RH | Biased (0/1) | - | Biased (0/1) | - | +| Wind | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | - | +| Precipitation | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | - | +| Solar Irradiance | No Obstacles (1/1) | - | No Obstacles (1/1) | - | +| Orientation | North | - | West | - | +| | | | | - | + +There are multiple issues in this SPV photo set: +- The station is mounted on a very short mast, positioning it close to the roof surface. This setup significantly affects temperature readings due to heat emitted by the concrete, leading to an overestimation of daytime temperatures. Additionally, placing the station so close to a surface usually results in underestimated wind speeds, as surface friction slows down the airflow. +- The round-shaped antenna above the station may obstruct raindrops from entering the rain gauge, potentially impacting precipitation measurements. +- The user has uploaded two photos showing the northern and western cardinal directions. These are only partially valid: in the first photo (north), the area behind the wall is not visible. In the second photo (west), half of the horizon is obscured by the wall. As a result, we cannot confirm whether additional obstacles may exist that could affect the measurements. +- A third photo, which also shows part of the northern horizon, is practically unusable and is therefore marked as invalid. +- Finally, there are no photos showing the eastern and southern directions, meaning these two cardinal points will be graded with a score of 0. + +### Short Mast, Chimney and Obstacles + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Mid | Mid | Mid | Mid | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | Significant Obstacles (0/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | Small Obstacles (0.5/1) | +| Precipitation | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | Small Obstacles (0.5/1) | +| Orientation | North | West | East | South | +| | | | | | + +This is an apparently satisfactory deployment. And it should be noted that, although the photos are in portrait mode, they adequately capture the surrounding area. However, there is a series of issues, which are: +- The station is mounted on a mast that provides approximately 1 meter distance from the roof. However, the mast is installed on top of a chimney, which, along with the limited distance, can introduce errors in temperature, humidity, and wind measurements under certain conditions. +- The trees located to the north, south, and especially the east are particularly tall and relatively close to the station. This setup can significantly affect wind measurements, as well as precipitation readings when rain is accompanied by wind from those directions. It may also interfere with solar radiation measurements due to shading. + +### Insufficient Number of Photos and Short Mast + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid | (0/1) | (0/1) | +| Mast Height | Low | Low | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Biased (0/1) | Biased (0/1) | - | - | +| Wind | Small Obstacles (0.5/1) | No Obstacles (1/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Small Obstacles (0.5/1) | No Obstacles (1/1) | - | - | +| Orientation | West | East | - | - | +| | | | - | - | + +This particular station appears to fail to meet several of the SPV mechanism’s criteria: +- The station is mounted on a short mast over a black surface. The temperature measurements, especially during the day, are significantly affected. At the same time, the airflow may be influenced by the building on which the station is mounted +- There are also trees nearby that may affect both the airflow and block sunlight from reaching the solar radiation sensor. +- Although, in the photo depicting the eastern horizon, the problem with airflow still exists, since the horizon is generally open without obstacles, we give the user a small boost by scoring the wind aspect for this point of the horizon with a 1. +- The photos do not depict the entire western and eastern horizons, but they are sufficient to give us a clear picture of the surrounding area. However, there are no photos depicting the northern and southern horizons, which prevents the user from achieving a better score. + +### Missing Rain Gauge Cup and Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | (0/1) | (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | - | - | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Significant Obstacles (0/1) | Significant Obstacles (0/1) | - | - | +| Orientation | East | South | - | - | +| | | | - | - | + +This appears to be a correctly installed weather station. However, there are two critical points that prevent it from receiving an excellent score: +- The absence of photos depicting the remaining points of the horizon (north and west). +- The black cap of the rain gauge is missing, resulting in it recording almost no measurements. + +### Missing Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Valid (1/1) | Valid (1/1) | (0/1) | +| Mast Height | Proper | Proper | Proper | - | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | - | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| | | | | - | + +This station could have received the maximum score, but once again, it is the details that prevent the user from achieving a perfect rating: +- The three photos show almost a 180° range around the station. Although the photo depicting the south actually shows only part of it, it can be concluded that the horizon is clear of obstacles. This is not the case in the photo showing the northern horizon, where some nearby trees are visible. Ideally, we would want a photo covering the north. +- There is no photo showing the west at all. There could be a large tree or wall significantly affecting the station’s measurements. Although the station appears to be installed quite correctly, the inadequate depiction of the surrounding environment prevents the user from obtaining the maximum SPV score. + +### Missing Weather Station from Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|--------------------|--------------------|--------------------|--------------------| +| Photo Validity | Invalid (0/1) | Invalid (0/1) | Invalid (0/1) | (0/1) | +| Mast Height | - | - | - | - | +| Mast Inclination | - | - | - | - | +| Temperature and RH | - | - | - | - | +| Wind | - | - | - | - | +| Precipitation | - | - | - | - | +| Solar Irradiance | - | - | - | - | +| Orientation | - | - | - | - | +| | | | | - | + +This may be the perfect installation. However: +- The station is not visible in any of the photos. This means that we do not know which point of the horizon each photo depicts, the exact location and height of the station, or whether the location shown is indeed that of the station. +- In any case, we need four photos, one for each point of the horizon. + +### Short Mast and Missing Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Partly Valid (0.5/1) | - (0/1) | - (0/1) | +| Mast Height | Low | Low | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Biased (0/1) | Biased (0/1) | - | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Orientation | West | South | - | - | +| | | | - | - | + +Rooftops are among the best places to install a station in urban environments; however, all basic installation requirements must be met. In this particular case: +- The station is mounted on a very short mast in front of a ledge. This means it is heavily affected by heat from the concrete surfaces, while its proximity to the floor and the ledge increases surface roughness, slowing down or even altering the direction of airflow. +- There are no photos for all points of the horizon, which does not allow the reviewer to fully assess the station’s surrounding environment. +- This appears to be a potentially excellent installation site, but due to carelessness, the station misses out on a perfect score. + +### Two Photos - Two Aspects + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 |-------------------| +|----------------------|-------------------------------|----------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Partly Affected (0.5) | Biased (0/1) | - | - | +| Wind | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Precipitation | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Orientation | West | East | - | - | +| | | | - | - | + +This station is installed in a poor location, and not all the photos are informative: + +- One photo shows an open horizon without obstacles; however, a roof appears at the top of the image, which may “shield” the station under certain conditions. +- The other photo confirms what we suspected from the first one. There is a canopy almost directly above the station, a wall very close by, and to the right, a fairly tall building at a short distance. Here, the walls will add extra heat, causing erroneous temperature measurements, while in combination with the roof, the airflow is blocked from multiple directions, making the wind measurements completely unreliable. + +### Station within Backyards + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Partly Affected (0.5) | Partly Affected (0.5) | - | - | +| Wind | Significant Obstacles (0/1) | Small Obstacles (0.5) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Small Obstacles (0.5) | No Obstacles (1/1) | - | - | +| Orientation | West | North | - | - | +| | | | - | - | + +This station is located between buildings and their courtyards, which creates various problems: + +Large trees create wind shade, while the air can be funnelled between the buildings, causing the station to record a completely different wind direction and speed from the prevailing conditions in the area. +- Because the airflow can be significantly obstructed, the temperature of the air around the station differs from that of the free-flowing air. It may also be affected by the presence of nearby buildings. +- Here as well, photos for all points of the horizon are not available. + +### The Underrated Weather Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Invalid (0/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | - | - | - | +| Mast Inclination | Not Inclined | - | - | - | +| Temperature and RH | Valid | - | - | - | +| Wind | No Obstacles (1/1) | - | - | - | +| Precipitation | No Obstacles (1/1) | - | - | - | +| Solar Irradiance | No Obstacles (1/1) | - | - | - | +| Orientation | West | - | - | - | +| | | | - | - | + +This is probably an underrated station because: +- The user did not upload one photo for each point of the horizon. +- The photo showing the north is quite zoomed in, making it impossible to see the surrounding area. +- However, the single valid photo shows a potentially well-positioned station, but the photos needed to confirm this are missing. + +### A Rough Installation + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|--------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Invalid (0/1) | Valid (1/1) | Valid (1/1) | Partly Valid (0.5/1) | +| Mast Height | - | Mid | Mid | Mid | +| Mast Inclination | - | Inclined | Inclined | Inclined | +| Temperature and RH | - | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | - | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | - | No Obstacles (1/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | +| Solar Irradiance | - | No Obstacles (1/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | +| Orientation | - | North | East | West | +| | | | | | + +This station is located in an interesting area but installed in a very hasty manner: +- Two photos show the same point of the horizon. +- In the other photos, the mast appears to be tilted. However, the main reason the solar radiation measurements are invalid is that the station is positioned lower than the tops of the surrounding trees, which shade it. +- The nearby trees certainly cause wind shading, and in particular, the tree to the west is so close that rainfall may not be recorded correctly when the wind is from the west. The mast is poorly fixed and may wobble, preventing reliable wind measurements. +- The station is poorly secured and quite low, meaning the temperature may be significantly influenced by the ground. + +### A Chimney Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Invalid (0/1) | Valid (1/1) | Partly Valid (0.5/1) | +| Mast Height | Mid | - | Mid | Mid | +| Mast Inclination | Not Inclined | - | Not Inclined | Not Inclined | +| Temperature and RH | Partly Affected (0.5/1) | - | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | No Obstacles (1/1) | - | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | No Obstacles (1/1) | - | No Obstacles (1/1) | No Obstacles (1/1) | +| Orientation | South | - | West | North | +| | | | | | + +This station could have been among the excellent ones, but there are reasons why this is not the case: +- The station is very close to a chimney, which means that when the chimney is active, the temperature readings will be incorrect. The chimney may be permanently inactive, but this is something the reviewer cannot know. +- In addition, the station is very close to the chimney wall, which can cause various turbulent flows that may prevent accurate wind measurement. + +### The "Hidden" Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Partly Valid (0.5/1) | Partly Valid (0.5/1) | Partly Valid (0.5/1) | Partly Valid (0.5/1) | +| Mast Height | Low | Low | Low | Low | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Biased (0/1) | Biased (0/1) | Biased (0/1) | Biased (0/1) | +| Wind | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles | +| Precipitation | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles | +| Solar Irradiance | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | +| Orientation | East | North | South | West | +| | | | | | + +This station is clearly tucked inside a forest, placed on the balcony of a house, and this creates multiple problems: +- With many walls around it, the air cannot circulate freely, and some of these walls may heat up during the day, warming the adjacent air. +- The surrounding vegetation is dense, and in practice, the wind blowing in the area has little to do with what the station measures. At the same time, the tree canopy prevents a significant portion of precipitation from reaching the rain gauge. +- The dense vegetation also prevents accurate measurement of solar radiation. + +### The perfectly Imperfect + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Over | Over | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | - | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | - | +| Precipitation | Significant Obstacles (0/1) | Significant Obstacles (0/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Orientation | North | West | - | - | +| | | | - | - | + +This station is installed at a very high position, which is recorded by the SPV tool and is one of the station’s strong positives. However, mounting it on a pillar can be problematic: +- The pillar may block part of the precipitation when the wind blows from certain directions. +- Clearly, wind coming from the direction of the pillar will be underestimated, and its direction may not be accurately recorded. +- From the photos, it is unclear whether the pillar blocks solar radiation at sunrise, so it was not rated negatively for this. +- Here too, the four photos ,one for each point of the horizon, are missing. It is understandable that taking such photos might be difficult, but some could be taken from ground level, always including both the station and the surrounding area. + +### The Fence Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Proper | Proper | Proper | Proper | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Wind | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | Small Obstacles (0.5/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | No Obstacles (1/1) | +| Orientation | East | West | South | North | +| | | | | | + +This is a type of station installation we encounter often. Although the total height of the station from the ground matches the recommended mast height, the installation is problematic: +- The fence creates friction with the air, causing the flow to slow down and generate turbulent currents that make the anemometer record different wind directions and usually lower wind speeds than the prevailing ones. +- The station is very close to the fence material, and it is likely that the sensor records higher temperatures than expected. +- Tall trees are very close to the station and likely block both the airflow and the sun’s rays. + +### The Short-Mast Roof Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | - (0/1) | +| Mast Height | Mid | Mid | Mid | - | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | - | +| Temperature and RH | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Orientation | West | North | East | - | +| | | | | - | + +This station represents another common deployment method we often observe. Despite being installed on a roof, the recommended installation guidelines have not been followed: +- The photo that would depict the southern horizon is missing. If it were available, it would likely show that the roof reaches a level higher than the station, blocking at least the airflow (if not also sunlight when the sun is low, for example). If the station were placed at the roof’s peak on a mast of at least 1.25 m, the roof would not have a significant impact on wind and temperature measurements. +- The mast is much lower than the recommended height, and the temperature measurements are certainly affected by the dark-coloured roof. +- Airflow slows down near the roof tiles, and the building across the way, which has a higher roof, also partially blocks the wind. + +--- +# Weather R&D +Canonical: https://docs.weatherxm.com/weather-and-science/r&d +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/r&d.md + +# Weather R&D + +In this section you can find material that has resulted from internal research conducted at WeatherXM, which served as the basis for mechanisms and optimisations. + +## Contents + +- [**Obstacle Impact on Temperature and Wind**](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx): Analysis of experimental data for the investigation of the effect of obstacles (such as walls) in close proximity around a station on temperature and wind parameters. +- [**SQC - Constancy Analysis Report**](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx): Analysis of data from properly deployed WeatherXM stations distributed worldwide, with the aim of determining the conditions under which various parameters can remain constant for hours. +- [**Theoretical Solar Irradiance**](/weather-and-science/r&d/theoretical-solar-radiation.mdx): The method used for calculating the theoretical solar irradiance for a given date of the year and location of the world. + +--- +# Theoretical solar Irradiance +Canonical: https://docs.weatherxm.com/weather-and-science/r&d/theoretical-solar-radiation +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/r&d/theoretical-solar-radiation.md + +# Theoretical Solar Irradiance +Dr. Stavros Keppas, 07/06/2023 + +## Calculating the theoretical solar irradiance + +The theoretical diurnal solar irradiance varies with the latitude, the day (of the year) and the time during the day. It can be calculated through the calculations described below (Mikulović et al., 2015). This methodology has been developed in order to be applied on data of 1-minute temporal resolution. The input variables are displayed in Table 1, while the required for calculations constants are shown in Table 2. + +**Table 1** - Input variables and their format/units + +| Variable | Format and Units | +|---------------|---------------------------------------------------| +| Latitude | decimal in °, e.g., 40.52° (use 2 decimals) | +| Longitude | decimal in °, e.g., 15.25° (use 2 decimals) | +| Date | YYYY-MM-DD, e.g., 2022-08-01 | +| DT (Local Hour - GMT) | In hours | +| Local Hour | Integer between 0-23 | +| Local Minute | Integer between 0-59 | +| Julian Day | e.g., 25/2 is the day 56 | + +**Table 2** - Constants that are used in the calculations + +| Constant Variable | Value | +|--------------------------|-------------------------------------------| +| Solar Constant (σ) | 1367 W m−2 | +| Reflective Coefficient | 0.2 (for ordinary ground or grass) | + +The Julian day can be calculated using the datetime module in python and the following commands: + +```python +fmt='%Y-%m-%d' +sdtdate = datetime.strptime(date, fmt) +sdtdate = sdtdate.timetuple() +local_day = sdtdate.tm_yday +``` + +Then, a series of calculations for the last 30-minutes in a 1-minute time interval to obtain the theoretical solar irradiance. Firstly, we calculate the **Sky Diffusion factor (SDF):** + +$$ +SDF = 0.095 + 0.04 \cdot \sin\left(\frac{360}{d_{totyear}} \cdot (d_{Julian} - 100) \cdot \frac{\pi}{180}\right) \tag{1} +$$ + +Where $d_{totyear}$ is the total number of days of the current year (365 for a typical year or 366 for a leap year) and $d_{Julian}$ the Julian day (see Table 1). + +Next, through the **Equation of Time (EoT)** we calculate the deviation between the solar time and the time shown by a typical clock: + +$$ +EoT = 9.87 \cdot \sin(2b) - 7.53 \cdot \cos(b) - 1.5 \cdot \sin(b) \tag{2} +$$ + +Where + +$$ +b = \frac{360}{d_{totyear} - 1} \cdot (d_{Julian} - 81) \cdot \frac{\pi}{180} +$$ + +The angle $\delta$ between the equator and the line drawn from the centre of the sun to the centre of the Earth can be obtained by the following equation: + +$$ +\delta = 23.45 \cdot \sin\!\left(\frac{360}{d_{totyear}} \cdot (d_{Julian} - 81) \cdot \frac{\pi}{180}\right) \tag{3} +$$ + +We also need to know the local time at which the sun is at the zenith (thus the local time of the solar noon) **SN**: + +$$ +SN = \frac{(12 \cdot 60) - 4 \cdot (Lon - LSTM) - EoT}{60} \tag{4} +$$ + +Where **Lon** is the longitude of the region and **LSTM** the local meridian calculated as: + +$$ +LSTM = 15 \cdot DT +$$ + +(for **DT** and **EoT** see Table 1). + +Then, we calculate the angle that the Earth must or has rotated so the sun is directly above the meridian of the region: + +$$ +HRA = 15 \cdot (SN - LT) \tag{5} +$$ + +Where **LT** is the local time in decimal format, calculated as: + +$$ +LT = local\_hour + \frac{local\_minute}{60} +$$ + +Next, we can now calculate the altitude (**SA**) of the sun from the horizon: + +$$ +SA = \frac{180}{\pi} \cdot \arcsin\Big( +\cos\Big(\frac{Lat \cdot \pi}{180}\Big) \cdot \cos\Big(\frac{\delta \cdot \pi}{180}\Big) \cdot \cos\Big(\frac{HRA \cdot \pi}{180}\Big) ++ \sin\Big(\frac{Lat \cdot \pi}{180}\Big) \cdot \sin\Big(\frac{\delta \cdot \pi}{180}\Big) +\Big) \tag{6} +$$ + +Where **Lat** is the latitude and **Lon** is the longitude of the region. + +The Extraterrestrial Solar Insolation (**IO**), which is the solar radiation that hits the top of the atmosphere, is given by: + +$$ +IO = \sigma \cdot \Big( 1 + 0.034 \cdot \cos\Big(\frac{360 \cdot d_{Julian}}{d_{totyear}} \cdot \frac{\pi}{180}\Big) \Big) \tag{7} +$$ + +Where **σ** is the solar constant (see Table 1). + +The Apparent Extraterrestrial Solar Insolation (**A**), then, is given by the following formula: + +$$ +A = 1160 + 75 \cdot \sin\Big( \frac{360}{d_{totyear}} (d_{Julian} - 275) \cdot \frac{\pi}{180} \Big) \tag{7} +$$ + +In order to simulate the average clarity of the atmosphere, we need to estimate its optical depth (**OD**): + +$$ +OD = 0.174 + 0.035 \cdot \sin\Big( \frac{360}{d_{totyear}} (d_{Julian} - 100) \cdot \frac{\pi}{180} \Big) \tag{8} +$$ + +However, we also need the **Air Mass Ratio (AMR)**, which is a measure indicating the distance that the solar ray travels within the atmosphere: + +$$ +AMR = \Bigg| \frac{1}{\sin\Big(\frac{SA \cdot \pi}{180}\Big)} \Bigg| \tag{9} +$$ + +We should also consider that the light sensor is a horizontally-aligned surface. In this case, the angle of incidence (**AoI**) is: + +$$ +AoI = \sin\Big(\frac{SA \cdot \pi}{180}\Big) \cdot \cos(0) \tag{10} +$$ + +Then, we are finally able to estimate the clear sky irradiance at Earth’s surface that hits a surface facing directly to the sun (**IB**), the irradiance that reaches the horizontally-aligned surface (**IBC**) and the irradiance reaching the surface after diffusion (**IDC**): + +$$ +IB = A \cdot e^{(-1) \cdot OD \cdot AMR} \quad \text{(If SA = 0, IB = 0)} \tag{11} +$$ + +$$ +IBC = IB \cdot AoI \tag{12} +$$ + +$$ +IDC = SDF \cdot IB \tag{13} +$$ + +Eventually, the total radiation (**IC**) that hits the light sensor is considered to be the summation of **IBC** and **IDC**: + +$$ +IC = IBC + IDC \quad \text{(in W m−2)} \tag{14} +$$ + +In order to apply a more realistic approach that is closer to the observed solar radiation, we used monthly constants suggested by the *Nijegorodov Model* (Nijegorodov, 1996; Ahmad and Tiwari, 2011) (**Table 3**). + +**Table 3 - Monthly constants for correcting theoretical solar radiation as suggested by Nijegorodov (1996).** + +| Month | Jan | Feb | Mar | Apr | May | Jun | Jul | Aug | Sep | Oct | Nov | Dec | +|:------|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:| +| **a** | 1163 | 1151 | 1142 | 1146 | 1152 | 1157 | 1158 | 1152 | 1150 | 1156 | 1167 | 1169 | +| **b** | 0.177| 0.174| 0.170| 0.165| 0.162| 0.160| 0.159| 0.164| 0.167| 0.172| 0.174| 0.177 | +| **c** | 0.114| 0.112| 0.110| 0.105| 0.101| 0.098| 0.100| 0.103| 0.107| 0.111| 0.113| 0.115 | + +Then, cos(θz) (θz is the solar zenith angle) is given by: + +$$ +\cos(\theta_z) = \sin(\text{lat}) \cdot \sin(\delta) + \cos(\text{lat}) \cdot \cos(\delta) \cdot \cos(\text{HRA}) \tag{15} +$$ + +In order to avoid any weird values (when solar angle is around the sunrise or sunset time) in the latter calculations: + +$$ +\cos(\theta_z) = 0.1 \quad \text{when} \quad \cos(\theta_z) < 0.001 +$$ + +Then, **IBC** is calculated from the following relationship instead of (12) (therefore (10) should not be used as well): + +$$ +IBC_{NM} = A \cdot \exp \left( \frac{-B}{\cos(\theta_z)} \right) \tag{16} +$$ + +Where *A* and *B* are given in **Table 3**. + +Next, **IDC** is corrected as: + +$$ +IDC_{NM} = C \cdot IDC \tag{17} +$$ + +Where *C* are given in **Table 3**. + +Finally, replacing (14), we use $IBC_{NM}$ and $IDC_{NM}$ in the following equation to calculate **IC**: + +$$ +IC = IBC_{NM} \cdot \cos(\theta_z) + IDC \tag{18} +$$ + +Note that $IC < 0$ should be replaced by $0 \, W/m^2$. + +--- +# Comparing WeatherXM with WMO Compliant Weather Stations +Canonical: https://docs.weatherxm.com/weather-and-science/weatherxm-vs-wmo-compliant +Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/weatherxm-vs-wmo-compliant.md + +Dr. Stavros Keppas, 30/10/23 - WeatherXM AG + +## 1. Introduction +In the pursuit of high-quality meteorological data, we aim to identify potential systematic errors and failures that the various WeatherXM station models may exhibit. For this reason, in the present study we compare impeccably installed WeatherXM weather stations, as assessed by the [SPV](https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation) mechanism (and the installation photos), with nearby meteorological stations that provide data via SYNOP. + +## 2. Data and Methods +In general, there is an inconsistency between airport data and that from WeatherXM stations, mainly in terms of the temporal sampling interval, but also in the set of available parameters. + +WeatherXM stations, under normal conditions (good connectivity), provide data every 1–3 minutes, whereas airport stations provide data every 30–180 minutes. For this reason, we aggregated WeatherXM's data in such a way that both data are aligend. For the aggregation method we averaged the observations 5 minutes before and after the timestamp of the WMO complinat station data (vector average for wind direction). In addition, the parameters provided by WeatherXM stations are consistent, while the parameters from airport stations often vary from station to station (for example, sometimes wind gust is missing, or the time step used for recording precipitation differs). + +Finally, although the reliability of satellite precipitation retrievals is not yet at a level where we could fully trust them, we use the [IMERG](https://gpm.nasa.gov/data/imerg) product with a spatial resolution of 0.1°. It is worth noting, however, that for the latest 3 months the data are only partially processed and may therefore have lower reliability. Full processing takes place after the 3-month period. + +## 3. Comparisons +### a. Thessaloniki Airport (Greece) vs WeatherXM H1 + +For this comparison, we used the data (between 11/2024 - 11/2025) from SYN16622 (SYNOP Mesonet) at the Thessaloniki Airport and the WeatherXM H1 station ([Humid Myrtle Hygrometer](https://explorer.weatherxm.com/stations/humid-myrtle-hygrometer)). The distance between the two stations is <2km, which allows for a valid comparison between them (**Figure 1**). + + + + **Figure 1**. (Left) Map with the locations and the distance between the SYN16622 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 2**, we can draw some useful conclusions, which are summarised in the following points: +- There is fair temperature agreement (usually WXM is lower - possible reasons could be the slightly different land use, lower mast leading to lower temperature in cloudless nights) +- There is fair wind direction agreement +- The weatherXM station underestimates wind speed/gust possibly due to shorter mast (3m instead of 10m) +- Significant discrepancy in precipitation, which needs further investigation + + + + **Figure 2**. Agreement plots between SYNOP16622 and WeatherXM H1 temperature, daily precipitation, wind speed, wind gust and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The SYNOP16622 wind gusts are never 0m/s at the airport, which may be due to a very sensitive wind gauge under calm conditions. Regarding precipitation, it seems that there is some agreement between SYNOP16622 and WeatherXM, but there is some difference in rain amount on certain episodes. It should be noted that the SYNOP16622 has larger distance from IMERG (**Figure 3**). + + + + **Figure 3**. Temperature, wind gust and daily precipitation time series plots of both SYNOP16622 and WeatherXM H1. + + +As we detected a significant deviation in precipitation recorded by WeatherXM H1 and SYN16622, we tried to find more references in order to understand which could be the ground truth. For this reason we used monthly accumulation from the Davis VP2 weather station supported by the National Observatory of Athens (NOA) (which is located ~3-4km from SYN16622 and WeatherXM H1) and IMERG precipitation retrievals. + +It seems that the WeatherXM H1 station is usually closer to any of IMERG and NOA (Davis VP2), while SYN16622 is far from all the other references. In particular, SYN16622 seems to significantly underestimate monthly precipitation by up to ~50% even in winter months (when precipitation may exhibit a more uniform spatial distribution as convective activity is limited in the area). + + + + **Figure 4**. (Left) Map with the locations and the distance between the SYN16622 (WMO), WeatherXM H1 and the National Observatory of Athens stations. (Right) Bar graph of total monthly precipitation recorded by the 3 stations and retrieved by IMERG. + + +### b. Rockwall Municipal Airport (Dallas) vs WeatherXM H2 + +For this comparison, we used the data (between 11/2024 - 11/2025) from KF46 (ASOS/AWOS Mesonet - Following some general WMO guidelines) at the Rockwall Municipal Airport and the WeatherXM H1 station ([Dandy Marigold Rainband](https://explorer.weatherxm.com/stations/dandy-marigold-rainband)). The distance between the two stations is ~20km over a flat area, which may allow for a valid comparison between them (**Figure 5**). + + + + **Figure 5**. (Left) Map with the locations and the distance between the KF46 and the WeatherXM H2 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 6**, we can draw some useful conclusions, which are summarised in the following points: +- There is a fair temperature agreement +- There is a fair wind direction agreement +- WeatherXM H2 seems to underestimate wind speed/gust due to shorter mast (3m instead of 10m) +- A weird cut-off threshold is present in wind speed/gust observations recorded by the KF46 +- There is a reasonable discrepancy in precipitation. The distance between stations can justify such differences especially during summer (due to convective activity) + + + + **Figure 6**. Agreement plots between KF46 and WeatherXM H2 temperature, daily precipitation, wind speed, wind gust and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The KF46 wind gusts are never 0m/s at the airport, and usually >7m/s (which may be suspicious). Regarding precipitation, it seems that there is a fair agreement between KF46, WeatherXM and IMERG considering the distance between the stations (**Figure 7**). + + + + **Figure 7**. Temperature, wind gust and daily precipitation time series plots of both KF46 and WeatherXM H2. + + +Finally, comparing the stations between them and both with the monthly IMERG precipitation retrievals, we found that all three sources of precipitation measurements are usually in fair agreement. KF46 and WeatherXM H2 are often close each other, while large discrepancies in certain months may be due to convective activity and distance between stations. + + + + **Figure 8**. Bar graph of total monthly precipitation recorded by the the KF46 (WMO), WeatherXM H2 stations and retrieved by IMERG. + + +### c. Osijek Airport (Croatia) vs WeatherXM H1 + +For this comparison, we used the data (between 11/2024 - 11/2025) from SYN14280 (SYNOP Mesonet) at the Osijek Airport and the WeatherXM H1 station ([Convective Chestnut Moisture](https://explorer.weatherxm.com/stations/convective-chestnut-moisture)). The distance between the two stations is ~14km over a generally flat area, which may allow for a valid comparison between them (**Figure 9**). + + + + **Figure 9**. (Left) Map with the locations and the distance between the SYN14280 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 10**, we can draw some useful conclusions, which are summarised in the following points: +- There is a fair temperature agreement +- There is a fair wind direction agreement (possibly because the WeatherXM station is ~10m above the ground and thus, the deployments are comparable) +- WeatherXM H1 seems to slightly underestimate wind speed/gust due to shorter mast (3m instead of 10m) +- The wind gust measurements were not available from the SYN14280 station, so no comparison could be conducted +- Some discrepancy in precipitation is present. The distance between station may be able to justify such differences especially during summer. + + + + **Figure 10**. Agreement plots between SYN14280 and WeatherXM H1 temperature, daily precipitation, wind speed and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The SYN14280 usually records lower amounts of precipitation comparing to the WeatherXM H1 and IMERG. However, during summertime, it seems that SYN14280 recorded larger amounts, which may be due to intense convective activity (**Figure 11-12**). + + + + **Figure 11**. Temperature, wind gust and daily precipitation time series plots of both SYN14280 and WeatherXM H1. + + + + + **Figure 12**. Bar graph of total monthly precipitation recorded by the the SYN14280 (WMO), WeatherXM H1 stations and retrieved by IMERG. + + +### d. Kortrjik Airport (Belgium) vs WeatherXM H1 + +For this comparison, we used the data (between 03/2024 - 11/2025) from SYN06414 (SYNOP Mesonet) at the Kortrjik Airport and the WeatherXM H1 station ([Hot Nickel Stratus](https://explorer.weatherxm.com/stations/hot-nickel-stratus)). The distance between the two stations is ~14km over a generally flat area, which may allow for a valid comparison between them (**Figure 13**). + + + + **Figure 13**. (Left) Map with the locations and the distance between the SYN06414 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 14**, we can draw some useful conclusions, which are summarised in the following points: +- There is fair temperature agreement +- There is fair wind direction agreement +- There is also fair wind speed agreement +- Wind gust measurements are not available from WMO's station +- We found some discrepancy in precipitation between the two stations. WeatherXM station seems to catch rain episodes that WMO misses. This may happen during convective phenomena, but it needs further investigation. + + + + **Figure 14**. Agreement plots between SYN06414 and WeatherXM H1 temperature, daily precipitation, wind speed and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Broadly, variations seem to be in agreement. There is a fair agreement in wind speed measurements despite the possible difference in mast height of the stations. Again, WeatherXM often measures larger amount of rain than WMO's station. However, there is coincidence of most episodes. Unfortunately, IMERG seems to exhibit false positives especially after August (**Figure 15**). + + + + **Figure 15**. Temperature, wind gust and daily precipitation time series plots of both SYN06414 and WeatherXM H1. + + +Looking at the monthly accumulations of precipitation (**Figure 16**), we can see significant discrepancy between the WMO, WeatherXM stations and IMERG retrieval. Although WeatherXM station seems to be closer to IMERG, it eventually seems that a reliable ground truth is missing. + + + + **Figure 16**. Bar graph of total monthly precipitation recorded by the the SYN06414 (WMO), WeatherXM H1 stations and retrieved by IMERG. + + +## 3. Conclusions + +After investigating a few couples of WeatherXM, we draw the following conclusions: +- There is always a fair agreement in temperature in all couples +- There is a fair agreement in wind direction (considering the variability of wind flow due to topography and even artificial objects) +- In general there is a good agreement in wind speed considering that WeatherXM stations are mounted on 3m masts instead of 10m. However, there was a great agreement when a WeatherXM station was mounted on the roof of a ~10m building. +- The wind speed observations recorded by WMO’s stations are sometime in intervals of 0.5-1m/s, which may raise questions on accuracy. +- There are cases of data gaps in precipitation recorded by WMO stations resulting to mising episodes. +- WMO’s large discrepancy in precipitation even when WeatherXM stations are as far as ~1-2km. IMERG and 3rd party realiable stations confirm the WMO’s inaccuracy in precipitation is some cases. +- The WeatherXM stations usually record larger amount of rain per episode. Considering that the rain gauge is shallow and with small diameter, we would expect WMO stations to record systematically larger amounts of rain +- In the end, it seems that we are still in the pursuit of publically available reference/ground truth observations of precipitation + +--- +# WeatherXM Pro +Canonical: https://docs.weatherxm.com/weatherxm-pro +Markdown: https://docs.weatherxm.com/llms-pages/weatherxm-pro.md + +## Access Hyperlocal Weather Data + +Improve your forecasts with our global weather station network. +Access hyperlocal data to optimize decisions and boost efficiency. Explore the [Pro](https://pro.weatherxm.com) **for free** and view nearby station data! +You can use either our user-friendly web interface, or easily integrate it with your solution via our API. + +:::note +Explore our WeatherXM Pro at [pro.weatherxm.com](https://pro.weatherxm.com) or [view its API documentation](https://pro.weatherxm.com/docs). +::: + +## Features + +### Historical & Real-Time Data +Access real-time and historical weather data from any WeatherXM station across the globe — delivered +seamlessly to your app for immediate insights and long-term analysis. + +### Forecast Accuracy Tracking + +
+ Continuously monitor and compare the performance of 40+ leading global weather models to identify the most accurate forecasts for your specific location. + This empowers you to make smarter, weather-driven decisions and optimize operations with confidence. + + For example: + - Agriculture: Choose the most reliable forecast to plan irrigation, planting, or harvest timing and reduce crop risk due to unexpected weather shifts. + - Energy: Improve load forecasting and renewable generation planning by using the most accurate model for wind or solar predictions. +
+ + +### Hyperlocal Station Forecasts + +
+ Get hyperlocal forecasts tailored to specific locations by leveraging our global network of weather stations. + Unlike traditional models, the Pro improves forecasts using real-world, ground-truth data from local stations. + + Our QoD mechanism ensures high data reliability by motivating and rewarding station owners to maintain their devices. + The better the station’s performance, the more rewards they earn—ensuring consistently high-quality data for businesses. +
+ + +### Access hyperlocal weather data via API +Access real-time, historical and forecast weather data effortlessly with our [developer-friendly API](https://pro.weatherxm.com/docs) +— built for seamless integration into your apps, platforms, and operational workflows. +Tap into high-quality data from a trusted global network, with 90%+ coverage reliability and quality. +[View our Pro API documentation here.](https://pro.weatherxm.com/docs) + +:::note +Explore our WeatherXM Pro at [pro.weatherxm.com](https://pro.weatherxm.com) or [view its API documentation](https://pro.weatherxm.com/docs). +::: + +--- +# Assembling WS1001 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/d1/assemble +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/assemble.md + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + +The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) +and another that measures the wind direction (though wind vane). +Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, +which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. +The wind vane should be placed on the shaft at the bottom of the sensor. +After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 20 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG1200 Gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +
+ +### External Battery pack installation + +While not mandatory, we strongly recommend the installation of the battery pack for the following reasons: + + 1. Extended Battery Life: Utilising only two batteries will result in the station depleting its power within 3 to 5 months, depending on environmental conditions. Installing the battery pack increases the battery life by approximately four times, significantly reducing the frequency of battery replacements. + 2. Improved Accessibility: The battery pack includes an extension cable (~3 meters), providing easier access for battery replacement when needed. + + + + 1. Open the Battery Pack: Begin by pulling the clip on the side of the battery pack to open it. + 2. Access the Battery Base: Gently pull out the battery base. You will see eight battery sockets arranged in groups of two (two pairs in the front and two in the back). + 3. Insert the Batteries: Place a battery in each socket, ensuring correct polarity alignment. + 4. Reassemble the Battery Pack: Carefully place the battery holders back into their original positions, ensuring they are oriented correctly (i.e., the cable should remain at the bottom and should not be twisted). + 5. Secure the Battery Pack: Close the lid of the battery pack and push the clip until it clicks into place. + 6. Prepare the Weather Station: On the weather station, remove the battery cover. + 7. Insert Dummy Batteries: Insert the dummy batteries into the station as you would with regular batteries, ensuring correct polarity. + 8. Close the Weather Station Cover: Close the embedded lid on the weather station and fasten the screw securely. + 9. Mount the Battery Pack: The battery pack can be attached to a pole using the two provided zip ties. + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing Bird Spikes +The bird spikes are designed to be installed on the rim of the rain cup to deter birds from perching on or around +the rain cup. + +#### Included Components + +Each weather station comes with the following bird spike components: + +- Metal Spikes +- Rim-Mounted Spike Holders: These are designed to fit around the edge of the rain cup. +- Metal Zip Ties: Two metal zip ties are included. Only one is required for installation; the second is provided as a spare. + +#### Installation Instructions + + 1. Prepare the Spike Holders: Insert a metal zip tie through each spike holder, ensuring that the holes are facing upward. + 2. Insert the Spikes: Place a metal spike into each hole on the spike holder. + + + + 3. Attach the Spike Holders to the Rain Cup: Wrap the zip tie around the rim of the rain cup and tighten it securely to prevent the spike holders from loosening or falling off. For easier installation, + it is recommended to first remove the rain cup by twisting it lightly before attaching the spike holders. + + + + 4. Secure the Metal Zip Tie: Carefully secure the metal zip tie on top of the rain cup to ensure the spike holders are firmly in place and will not fall off. + + + + 5. Place the spikes, short side down, in the designated spots on the ring. The final setup should match the image below. + + + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). + +--- +# Connect and Claim the Gateway +Canonical: https://docs.weatherxm.com/wxm-devices/d1/connect-and-claim +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/connect-and-claim.md + +## WG1200 Gateway + +The weather station comes together with the WG1200 Gateway. +The WG1200 Gateway receives all the meteorological data plus the location of the weather station, which are measured and transmitted every 16 seconds by the outdoor sensor +and displays them on its screen. + +In this chapter, you will find guidance to set up the WG1200 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. A reliable 2.4 GHz WiFi network (**5 GHz is not supported**) for the WG1200 Gateway to connect to. +1. The [WeatherXM](/wxm-devices/d1/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +
+ +## Step by Step Instructions + +### Connect WG1200 Gateway to power source and turn the gateway on + +The WG1200 Gateway must be connected to a power source at all times. + +:::caution +If WG1200 Gateway turns off, you will not receive \$WXM rewards, as you will not be able to share data with the WeatherXM network. **This will result in no $WXM rewards!** +WG1200 does not have a battery, so it must be connected to a power source at all times. +::: +
+ +### Change Frequency (Optional) + + + +The WG1200 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 3 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz +- Model C: 923 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency + + + + + + +

+1. Swipe right on the touch screen. +1. Click the Frequency options and select the new frequency your WG1200 Gateway will listen to. +1. A confirmation dialog will open. Read it carefully and click "Continue" or "Cancel" accordingly. +1. Finally, your WG1200 Gateway will restart after setting the frequency to the selected one. + +:::caution +If you don't use the correct frequency as your weather station, WG1200 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Connect WG1200 Gateway to WiFi + + + + + +

+1. Swipe right on the touch screen and select the Configure WiFi option. +1. The WG1200 Gateway will restart to enter configuration mode. +1. An Access Point will be created with SSID "WXM_WG1200", you should connect to it from your smartphone. It is normal not having internet connection while connected to it. +1. Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +1. Enter your WiFi credentials and click "Save". +1. The WG1200 Gateway will restart and connect to your WiFi network. + +By now, your WG1200 Gateway is set and ready for claiming. + +:::tip +In case of a successful connection, and the popup doesn’t open, navigate with your browser to 10.10.0.1 and follow the instructions displayed. +::: + +:::note +While you are connected to the "WXM_WG1200" network, you will not have internet access. +::: + +#### Video Guide + + + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Prepare for claiming your WG1200 Gateway + + + + + #### Navigate to WG1200 Gateway and reveal the QR code + + Swipe right on the touch screen and select the "Claim Device" option, a QR code will appear. + + You'll need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + + +:::tip +In case you have trouble scanning the QR code, you can manually type the serial number and claiming key. +::: + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: + +--- +# Box Contents of D1 bundle (WB1200) +Canonical: https://docs.weatherxm.com/wxm-devices/d1/contents +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/contents.md + +## Included + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Metal plate
    5. +
  5. U-bolts (x2)
    6. +
  6. Nuts (x4)
    7. +
  7. Wrench
    8. +
  8. Screwdriver
    9. +
  9. WG1200 Gateway
    10. +
  10. Power supply cable (USB-C)
    11. +
  11. External Battery Pack
    12. +
  12. Zip ties
    13. +
  13. Bird Spikes
    14. +
+ + +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole +1. USB power supply + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 20 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1001 Weather Station](/wxm-devices/m5/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG1200 Gateway (D1 WiFi) + + + +The WG1200 Gateway (D1 WiFi) is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via WiFi to the WeatherXM network. + +The D1 Gateway is advised to be placed indoors, in an environment of relatively constant temperature (ideally within a daily range of <4°C/7°F for proper functioning of the barometer). + +The D1 Gateway should be permanently connected to power and powered on in order to be able to receive, record and upload measurements to the Internet. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. + +--- +# Installing WS1001 Weather station +Canonical: https://docs.weatherxm.com/wxm-devices/d1/install-weather-station +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/install-weather-station.md + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ Thus, it is important that you are able to read all the measurements on the WG1200 Gateway's screen, + while you keep the outdoor sensor nearby (preferably not closer than 1.5m/5ft from the WG1200 Gateway though).
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. + +--- +# Introduction of D1 bundle (WB1200) +Canonical: https://docs.weatherxm.com/wxm-devices/d1/introduction +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/introduction.md + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG1200 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG1200 Gateway + +- 3.95" Capacitive touch screen +- ATECC608 hardware encryption +- BLE + LoRa +- Forwards weather data via WiFi +- Powered by USB (power adapter not included) +- Over-the-air firmware upgradable + +### WS1001 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG1200 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1200 is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 20sec + + + + + +Powered via a small solar panel and batteries and communicates with the WG1200 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1200 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + + +--- +# Maintenance of WS1001 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/d1/maintenance +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/maintenance.md + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG1200 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/d1/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: + +--- +# Troubleshooting of D1 bundle (WB1200) +Canonical: https://docs.weatherxm.com/wxm-devices/d1/troubleshooting +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/troubleshooting.md + +## Weather Station + +### Device Alert: "No Weather Station Signal" +![No Signal](image) + +If the error message "No Weather Station Signal" is displayed on the WG1200 Gateway, the WG1200 Gateway is not receiving RF signals. +This can be due to a variety of reasons. +Here are some steps to troubleshoot the issue: + +First make sure you WG1200 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/d1/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/d1/contents#outdoor-weather-station)) for flashing. +The LED should flash every 20 seconds. + +If the LED is not flashing every 20 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors, or the WG1200 Gateway has not been reset. +The solution may be as simple as powering down and up the WG1200 Gateway. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG1200 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. +1. WG1200 Gateway should display all the observations measured by the weather station. +1. Try to place the WG1200 Gateway at the desirable point and check that it receives data. + Ensure the power adapter if used is not too close to the WG1200 Gateway and the WG1200 Gateway is not close to other electrical noise generating devices + such as TVs, monitors, computers and transmitting devices. +1. If you still have intermittent problems, move the weather station and the WG1200 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG1200 Gateway. + Relocate the weather station and WG1200 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. + +
+ +### Device Alert: "Station Signal is Low" +![Signal Low](image) +When the RF connection with the Weather Station is weak, the WG1200 Gateway will display "Station Signal is Low" resulting to [Data Gaps](/rewards/rewards-troubleshooting#weather-data-gaps) and reduced Rewards. +- If the signal is low, make sure the weather station is within the range of 50m/164ft from the WG1200 Gateway. +- If the weather station is within the range, try to move the WG1200 Gateway in another location to improve the signal quality. + +:::note +Low signal quality may be due to obstacles between the weather station and the WG1200 Gateway, such as walls, trees, or other buildings. +::: + +
+ +### Device Alert: "Station Reported Abnormal Values" +![Abnormal Values](image) + +This message is displayed when the weather station reports values that are out of the ordinary. This can be due to a variety of reasons, such as: +- Spikes on the data measured. +- One or more variables are constant for long periods of time. +- A sensor may be defective. + +Please make sure you have followed [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### Device Alert: "Station Battery Level is Low" + +![Battery Low](image) + +If your WG1200 Gateway displays "Station Battery Level is Low" on the screen, the weather station will run out of battery soon. + +Replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by reading [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation). + +
+ +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +
+ +### One or more variables are extremely high, low, or constant for long periods of time. + +If you notice that some variables are extreme or constant it is possible you need to replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Pressure on WG1200 Gateway appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +
+ +## WiFi Connectivity + +### Device Alert: "No Internet connection" + +![No WiFi](image) + + When the WiFi connection is lost, the warning "No Internet connection" is displayed on the WG1200 Gateway. + This can be due to a variety of reasons: +Here are some steps to troubleshoot the issue: + +- Make sure the WiFi network is working properly. +- If you have never been able to configure WiFi to a working state, make sure your WiFi supports 2.4 GHz signals. The gateway does not support WiFi that uses the 5 GHz spectrum. +- Make sure you configured the correct SSID and password. +- Repeat the [procedure](/wxm-devices/d1/connect-and-claim#connect-wg1200-gateway-to-wifi) if necessary to verify. + +If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### Wifi Repeater +Usually, using a WiFi repeater is not an issue, but in some cases it may affect your Gateway's connection. If you are experiencing issues with your WG1200 Gateway, try to connect it directly to your router and see if the problem persists. If it does not, +then the issue is with the repeater. If it does, please contact us through [support](https://support.weatherxm.com). + +
+ +### WG1200 Gateway not working in 5 GHz WiFi. +WG1200 Gateway is designed to work **only** at the 2.4GHz frequency. Please make sure the 2.4Ghz band on your router is enabled. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### I don't see the Wi-Fi name "WXM_WG1200" for initial setup on the app. + +It might take some time and attempts for it to connect. Please make sure that your Wi-Fi supports 2.4 GHz signals. You may also need to try from a different phone. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +## GPS Location + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## Other Issues + +### My WG1200 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### What can I do if my WG1200 Gateway is switching off frequently? + +Please disconnect the WG1200 Gateway from the power source and plug it back to the power source. You can also try using a different USB cable and another wall adapter. + +
+ +### Why is my station showing offline? + +Assuming that the WG1200 Gateway unit is powered on, this may be due to a bad internet connection or bad RF connection between the D1 Gateway and the outdoor station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: + +--- +# Weather Station Deployment Examples +Canonical: https://docs.weatherxm.com/wxm-devices/deployment-examples +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/deployment-examples.md + +Use these real-world examples to evaluate where to install a WeatherXM station and how nearby roofs, walls, trees, fences and chimneys can affect measurements. For the best data quality, place the outdoor sensor as high and as clear of nearby obstacles as practical, following the installation guidance for your station model. + +## Good Installations + +### Case 1 + + ![WeatherXM station installed high above an apartment roof on a tall mast](image) + + The station has been deployed at the highest point of this apartment, which is located at an area, where buildings present similar heights. Thus, the outdoor sensor is over the level of any object around. It is also placed on a >2m mast and, hence, temperature/humidity is not affected by the roof’s material. + + +
+ +### Case 2 + + + ![WeatherXM station on a rooftop with a clear horizon and nearby trees below sensor level](image) + ![Second view of a rooftop WeatherXM station with mostly unobstructed exposure](image) + + + + The station has been deployed at the highest point of this apartment, which is located at an area, where other obstacles are not much higher. Notice that the level of the outdoor sensor is very close to the level of the tree tops, and so wind/rain measurements shouldn’t be affected. It is also placed on a >2m mast and, hence, temperature/humidity is not affected by the roof’s material. + + + + +
+ +### Case 3 + + ![WeatherXM station on a very tall mast above a roof and sparse palm trees](image) + + The station has been deployed at the highest point of this apartment, which is located at an area, where other obstacles are not much higher. In addition, the mast is ~7m makes the deployment quite ideal. Sparse thin coconut trees shouldn’t be able to affect measurements. In a case like that the user should tight firmly the wires that stabilise the mast. Otherwise, the mast may significantly oscillate, producing faulty wind and especially rain measurements. + + +
+ +### Case 4 + + + ![WeatherXM station on a 2.5 metre mast in an open area with a clear horizon](image) + ![Second view of an open WeatherXM station deployment with a distant house](image) + + + + The station has been deployed at a 2.5m mast with a clear horizon with no obstacles. The only obstacle is a house (4-7m height) being located at the east, but it’s 25m away.Thus, the maximum difference of obstacle-station level heights is 7-2.5=4.5m, which means that the distance is at least >5 times the height of the obstacle. Although the station is considered as well deployed, optionally would be placed on a 5m mast to completely follow the WMO criteria. + + + + +
+ +## Deployments that need attention + +### Case 5 + + + ![WeatherXM station mounted near a fence, bush and surrounding buildings](image) + ![Second view of a WeatherXM station with nearby fence and vegetation obstacles](image) + + + + The station has not been deployed at the highest possible place because there are higher buildings around. It is placed on a fence being only ~1m higher from it and there are objects (like the bush) that are closer than 2m, which is the smallest allowed distance between the sensors and any horizontal surface under the level of the outdoor sensor. + + + +:::caution +The fence can cause turbulence that may affect the wind measurements. The buildings around may create a “wind shade” and, thus, wind speed will be lower than expected, while wind direction will be more variable than expected. Finally, as the bush is quite close, this may affect temperature and humidity but in a less significant way. Solar radiation may not be affected, but there are not enough photos to come to such a conclusion. +::: + +:::tip +The station should be moved to the terrace of the house (which is not visible in the photos). If the house terrace is at the level of the surrounding terraces and the outdoor sensor is placed on a >2m mast, then the weather station should be considered as well deployed. +::: + +
+ +### Case 6 + + + ![East-facing view from a WeatherXM station surrounded by trees](image) + ![North-facing view from a WeatherXM station surrounded by trees](image) + + + ![South-facing view from a WeatherXM station surrounded by trees](image) + ![West-facing view and obstacle context for a WeatherXM station deployment](image) + + + + Photos showing from left to right the East - North - South - West horizon of the outdoor sensor. The last photo at the bottom shows Google Maps top view of the area together with distances from the surrounding obstacles + + + +:::note +The station sits in an area surrounded by tall trees some of which are too close to the station especially to the south and west. +::: + +:::caution +The trees at the west and south have a significant impact on wind speed/direction (block the flow), solar radiation (as they shade the sensor), rain measurements (e.g., rain with south wind will be underestimated as trees create a “rain shade”), temperature and humidity possibly in a more insignificant way (as sun turns from east to west through the day, the sensor will differentially be shaded from time to time recording variable and changing temperature and humidity). +::: + +:::tip + + ![Suggested nearby rooftop location for improving a WeatherXM station deployment](image) + + The station could ideally be moved to the roof of the nearby building (using a 3-4m-mast) in order to be placed as higher as possible to avoid at least the closest obstacles. Otherwise (if there is no other available place) a 5-7m-mast could be used at the same place in order to place the weather station above the level of the closer obstacles. + + +::: + +
+ +### Case 7 + + ![WeatherXM station mounted only slightly above a wooden structure](image) + + The station is placed just a few tens of centimetres over a wooden structure. From this photo it is unknown if there are any obstacles at the north-east-south. + + +:::caution +The wooden structure may cause turbulent air flow that would have a significant impact on wind measurements. If there are obstacles at the blind side, they could affect measurements in variable ways. +::: + +:::tip +The outdoor sensor should be placed on a higher mast (at least a 2m one) over the wooden structure. If there are higher buildings etc around, the sensor should be moved at the highest possible point (always using a at least 2m mast). +::: + +
+ +### Case 8 + + + ![WeatherXM rooftop station before raising the sensor farther above nearby obstacles](image) + ![WeatherXM rooftop station after raising the sensor to improve exposure](image) + + + + Photos show before (left) and after (right) of the deployment of a station in order to optimise its position. + + + +:::note +The station is placed on the roof of a building, but there are tall trees to the west. +::: + +:::caution +Tall trees will affect rain and wind measurements when wind blows from the west. According to WMO a wind gauge should be placed at a distance 10 times the higher obstacle height. +::: + +:::tip +The user moved the outdoor sensor higher by ~1m increasing the distance-height ratio (distance from obstacle/ height of obstacle-height of outdoor sensor) from 2 to 3. In such a case there’s no better solution than that. Ideally, the mast should be 4-6m above the roof, but the maintenance may not be a safe job. +::: + +
+ +### Case 9 + + + ![WeatherXM station mounted beside and below the top of a chimney structure](image) + + + + The station is deployed on the east side of a chimney structure below its top level and close by chimneys. + + + +:::caution +The structure causes rain and especially wind shade. Wind speed and particularly wind direction may significantly differ from the actual situation even when wind blows from other than west directions. Moreover, if the chimney is active, temperature will be systematically higher. +::: + +:::tip +In case that chimney is inactive, the outdoor sensor should be placed at the same position but on a (at least) 2m mast. If the chimney is active, then the sensor should be placed at least 5 meters away and again on a 2m (or more) mast. +::: + +
+ +### Case 10 + + + ![WeatherXM station installed on a balcony close to a wall and roof](image) + + + + The station is deployed on a balcony with a wall and a roof being fairly close (to the west). + + + +:::caution +The roof and the wall are significant obstacles affecting all of the measured meteorological parameters (e.g., missing rain episodes, incorrect wind speed and direction, increased temperature). +::: + +:::tip +A balcony is not a place for a weather station. The station should be moved to the roof of this apartment following the general guidelines. +::: + +
+ +### Case 11 + + + ![WeatherXM station near a chimney with taller buildings and trees around it](image) + + + + The station is deployed on an appropriate mast, but it is not at the highest possible point of the area (there is a higher building to the north and tall trees to the south). There is also a chimney below it. + + + +:::caution +If the chimney is active, then temperature will be systematically increased. Due to taller obstacles around, wind and rain will include significant errors. +::: + +:::tip +The station should be moved to the higher roof as far as possible from the chimneys on a tallest possible mast in order to skip the tall tree obstacle to the south. +::: + +--- +# frequency-explanation-d1-m5-pulse +Canonical: https://docs.weatherxm.com/wxm-devices/frequency-explanation-d1-m5-pulse +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/frequency-explanation-d1-m5-pulse.md + +import 'tippy.js/dist/tippy.css'; // optional + + + + + +--- +# Frequency Plans +Canonical: https://docs.weatherxm.com/wxm-devices/frequency-plans +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/frequency-plans.md + +In this page you can find a mapping table listing all ISM band frequency plans per country, +as well as the corresponding frequency used by our products in these countries. + +:::tip +If a country's ISM frequency is marked as "-" or it is not listed, you are advised to check with the +country's regulations and use the appropriate frequency. You can find the respective +regulatory body for each country in the list [here](https://en.wikipedia.org/wiki/List_of_telecommunications_regulatory_bodies#By_country). +::: + +Source: [LoRaWAN Regional Parameters RP002-1.0.5](https://resources.lora-alliance.org/technical-specifications/rp002-1-0-5-lorawan-regional-parameters) (Published October 8, 2025). This document describes Regional Parameters worldwide, and the country cross-reference table is intended as a quick reference of unlicensed bands and suggested channel plans. + +## A + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|----------------|---------------| +| Afghanistan | AF | - | | Check Helium Explorer | +| Aland Islands | AX | EU868 | EU868 | ✓ | +| Albania | AL | EU868 | EU868 | ✓ | +| Algeria | DZ | EU868 | EU868 | ✓ | +| American Samoa | AS | US915 | US915 | ✓ | +| Andorra | AD | EU868 | EU868 | ✓ | +| Angola | AO | EU868 | EU868 | ✓ | +| Anguilla | AI | AU915_SB1 | US915 and AS923 | ✓ | +| Antarctica - Chilean | AQ | - | | Check Helium Explorer | +| Antarctica - Australian | AQ | - | | Check Helium Explorer | +| Antarctica - British | AQ | - | | Check Helium Explorer | +| Antarctica - Argentine | AQ | - | | Check Helium Explorer | +| Antigua and Barbuda | AG | - | | Check Helium Explorer | +| Argentina | AR | AU915_SB1 | US915 and AS923 | ✓ | +| Armenia | AM | EU868 | EU868 | ✓ | +| Aruba | AW | - | | Check Helium Explorer | +| Australia | AU | AU915_SB2 | US915 and AS923 | ✓ | +| Austria | AT | EU868 | EU868 | ✓ | +| Azerbaijan | AZ | EU868 | EU868 | ✓ | + +## B + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------------|--------------|---------------|--------------------|---------------| +| Bahamas | BS | US915 | US915 | ✓ | +| Bahrain | BH | EU868 | EU868 | ✓ | +| Bangladesh | BD | AS923_1 | AS923 | ✓ | +| Barbados | BB | AU915_SB1 | US915 and AS923 | ✓ | +| Belarus | BY | EU868 | EU868 | ✓ | +| Belgium | BE | EU868 | EU868 | ✓ | +| Belize | BZ | AU915_SB1 | US915 and AS923 | ✓ | +| Benin | BJ | EU868 | EU868 | ✓ | +| Bermuda | BM | US915 | US915 | ✓ | +| Bhutan | BT | EU868 | EU868 | ✓ | +| Bolivia | BO | AS923_1 | US915 and AS923 | ✓ | +| Bonaire, Sint Eustatius & Saba | BQ | EU868 | EU868 | ✓ | +| Bosnia and Herzegovina | BA | EU868 | EU868 | ✓ | +| Botswana | BW | EU868 | EU868 | ✓ | +| Bouvet Island | BV | EU868 | EU868 | ✓ | +| Brazil | BR | AU915_SB2 | US915 and AS923 | ✓ | +| British Indian Ocean Territory | IO | - | | Check Helium Explorer | +| British Virgin Islands | VG | AU915_SB1 | US915 and AS923 | ✓ | +| Brunei | BN | AS923_1 | AS923 | ✓ | +| Bulgaria | BG | EU868 | EU868 | ✓ | +| Burkina Faso | BF | EU868 | EU868 | ✓ | +| Burundi | BI | EU868 | EU868 | ✓ | + +## C + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------------------------|--------------|---------------|--------------------|----------------| +| Cambodia | KH | AS923_1 | AS923 | ✓ | +| Cameroon | CM | EU433 | | Check Helium Explorer | +| Canada | CA | US915 | US915 | ✓ | +| Cape Verde | CV | EU868 | EU868 | ✓ | +| Cayman Islands | KY | US915 | US915 | ✓ | +| Central African Republic | CF | - | | Check Helium Explorer | +| Chad | TD | - | | Check Helium Explorer | +| Chile | CL | AU915_SB1 | US915 and AS923 | ✓ | +| China | CN | CN470 | | ✓ | +| Christmas Island | CX | AU915_SB2 | US915 and AS923 | ✓ | +| Cocos (Keeling) Islands | CC | AU915_SB2 | US915 and AS923 | ✓ | +| Colombia | CO | AU915_SB1 | US915 and AS923 | ✓ | +| Comoros | KM | EU868 | EU868 | ✓ | +| Congo (DRC) | CD | EU868 | EU868 | ✓ | +| Congo (Republic) | CG | - | | Check Helium Explorer | +| Cook Islands | CK | AS923_1 | US915 and AS923 | ✓ | +| Costa Rica | CR | AS923_1 | AS923 | ✓ | +| Côte d'Ivoire | CI | EU868 | EU868 | ✓ | +| Croatia | HR | EU868 | EU868 | ✓ | +| Cuba | CU | AS923_3 | US915 | ✓ | +| Curaçao | CW | AS923_1 | AS923 | ✓ | +| Cyprus | CY | EU868 | EU868 | ✓ | +| Czech Republic | CZ | EU868 | EU868 | ✓ | + +## D + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|---------------| +| Denmark | DK | EU868 | EU868 | ✓ | +| Djibouti | DJ | - | | Check Helium Explorer | +| Dominica | DM | AU915_SB1 | US915 and AS923 | ✓ | +| Dominican Republic | DO | AU915_SB1 | US915 and AS923 | ✓ | + +## E + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------------|--------------|---------------|--------------------|----------------| +| Ecuador | EC | AU915_SB1 | US915 and AS923 | ✓ | +| Egypt | EG | EU868 | EU868 | ✓ | +| El Salvador | SV | AU915_SB1 | US915 and AS923 | ✓ | +| Equatorial Guinea | GQ | EU868 | EU868 | ✓ | +| Eritrea | ER | - | | Check Helium Explorer | +| Estonia | EE | EU868 | EU868 | ✓ | +| Eswatini (Swaziland) | SZ | EU868* | EU868 | ✓ | +| Ethiopia | ET | - | | Check Helium Explorer | + +## F + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------------------------|--------------|---------------|--------------------|----------------| +| Falkland Islands | FK | EU868 | EU868 | ✓ | +| Faroe Islands | FO | EU868 | EU868 | ✓ | +| Fiji | FJ | EU868 | EU868 | ✓ | +| Finland | FI | EU868 | EU868 | ✓ | +| France | FR | EU868 | EU868 | ✓ | +| French Guiana | GF | EU868 | EU868 | ✓ | +| French Polynesia | PF | EU868 | EU868 | ✓ | +| French Southern Territories | TF | EU868 | EU868 | ✓ | + +## G + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------|--------------|---------------|--------------------|----------------| +| Gabon | GA | EU868 | EU868 | ✓ | +| Gambia | GM | EU433 | | Check Helium Explorer | +| Gaza Strip | PS | - | | Check Helium Explorer | +| Georgia | GE | EU868 | EU868 | ✓ | +| Germany | DE | EU868 | EU868 | ✓ | +| Ghana | GH | EU868 | EU868 | ✓ | +| Gibraltar | GI | EU868 | EU868 | ✓ | +| Greece | GR | EU868 | EU868 | ✓ | +| Greenland | GL | EU868 | EU868 | ✓ | +| Grenada | GD | AU915_SB1 | US915 and AS923 | ✓ | +| Guadeloupe | GP | EU868 | EU868 | ✓ | +| Guam | GU | US915 | US915 | ✓ | +| Guatemala | GT | AU915_SB1 | US915 and AS923 | ✓ | +| Guernsey | GG | EU868 | EU868 | ✓ | +| Guinea | GN | EU433 | | Check Helium Explorer | +| Guinea-Bissau | GW | - | | Check Helium Explorer | +| Guyana | GY | US915 | US915 | ✓ | + +## H + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-----------------------------------|--------------|---------------|--------------------|----------------| +| Haiti | HT | - | | Check Helium Explorer | +| Heard Island and McDonald Islands | HM | AU915_SB2 | US915 and AS923 | ✓ | +| Honduras | HN | AU915_SB1 | US915 and AS923 | ✓ | +| Hong Kong | HK | AS923_1 | AS923 | ✓ | +| Hungary | HU | EU868 | EU868 | ✓ | + +## I + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------|--------------|---------------|--------------------|-------| +| Iceland | IS | EU868 | EU868 | ✓ | +| India | IN | IN865 | | ✓ | +| Indonesia | ID | AS923_2 | AS923 | ✓ | +| Iran | IR | EU868 | EU868 | ✓ | +| Iraq | IQ | EU868 | EU868 | ✓ | +| Ireland | IE | EU868 | EU868 | ✓ | +| Isle of Man | IM | EU868 | EU868 | ✓ | +| Israel | IL | AS923_4 | | ✓ | +| Italy | IT | EU868 | EU868 | ✓ | + +## J + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|--------------------|--------| +| Jamaica | JM | AU915_SB1 | US915 and AS923 | ✓ | +| Japan | JP | AS923_1 | AS923 | ✓ | +| Jersey | JE | EU868 | EU868 | ✓ | +| Jordan | JO | EU868 | EU868 | ✓ | + +## K + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------|--------------|---------------|--------------------|----------------| +| Kazakhstan | KZ | IN865 | | ✓ | +| Kenya | KE | EU868 | EU868 | ✓ | +| Kiribati | KI | - | | Check Helium Explorer | +| Kosovo | XK | EU868 | EU868 | ✓ | +| Kuwait | KW | EU868 | EU868 | ✓ | +| Kyrgyzstan | KG | - | | Check Helium Explorer | + +## L + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------|--------------|---------------|--------------------|----------------| +| Laos | LA | AS923_1 | AS923 | ✓ | +| Latvia | LV | EU868 | EU868 | ✓ | +| Lebanon | LB | EU868 | EU868 | ✓ | +| Lesotho | LS | EU868* | EU868 | ✓ | +| Liberia | LR | - | | Check Helium Explorer | +| Libya | LY | AS923_3 | US915 | ✓ | +| Liechtenstein | LI | EU868 | EU868 | ✓ | +| Lithuania | LT | EU868 | EU868 | ✓ | +| Luxembourg | LU | EU868 | EU868 | ✓ | + +## M + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|----------------| +| Macau | MO | AS923_1 | AS923 | ✓ | +| North Macedonia | MK | EU868 | EU868 | ✓ | +| Madagascar | MG | EU868 | EU868 | ✓ | +| Malawi | MW | EU868* | EU868 | ✓ | +| Malaysia | MY | AS923_1 | AS923 | ✓ | +| Maldives | MV | EU868 | EU868 | ✓ | +| Mali | ML | EU433 | | Check Helium Explorer | +| Malta | MT | EU868 | EU868 | ✓ | +| Marshall Islands | MH | - | | Check Helium Explorer | +| Martinique | MQ | EU868 | EU868 | ✓ | +| Mauritania | MR | EU868 | EU868 | ✓ | +| Mauritius | MU | EU868 | EU868 | ✓ | +| Mayotte | YT | EU868 | EU868 | ✓ | +| Mexico | MX | US915 | US915 | ✓ | +| Micronesia | FM | - | | Check Helium Explorer | +| Moldova | MD | EU868 | EU868 | ✓ | +| Monaco | MC | EU868 | EU868 | ✓ | +| Mongolia | MN | - | | Check Helium Explorer | +| Montenegro | ME | EU868 | EU868 | ✓ | +| Montserrat | MS | AU915_SB1 | US915 and AS923 | ✓ | +| Morocco | MA | EU868 | EU868 | ✓ | +| Mozambique | MZ | EU868* | EU868 | ✓ | +| Myanmar | MM | AS923_1 | AS923 | ✓ | + +## N + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------|--------------|---------------|----------------------|----------------| +| Namibia | NA | EU868 | EU868 | ✓ | +| Nauru | NR | - | | Check Helium Explorer | +| Nepal | NP | IN865 | | ✓ | +| Netherlands | NL | EU868 | EU868 | ✓ | +| Netherlands Antilles | AN | EU868 | EU868 | ✓ | +| New Caledonia | NC | EU868 | EU868 | ✓ | +| New Zealand | NZ | AS923_1 | US915 and AS923 | ✓ | +| Nicaragua | NI | AU915_SB1 | US915 and AS923 | ✓ | +| Niger | NE | IN865 | | ✓ | +| Nigeria | NG | EU868 | EU868 | ✓ | +| Niue | NU | AS923_1 | US915 and AS923 | ✓ | +| Norfolk Island | NF | AU915_SB2 | US915 and AS923 | ✓ | +| North Korea | KP | - | | Check Helium Explorer | +| Northern Mariana Islands | MP | US915 | US915 | ✓ | +| Norway | NO | EU868 | EU868 | ✓ | + +## O + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|-------------|-------| +| Oman | OM | EU868 | EU868 | ✓ | + +## P + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------------|--------------|---------------|----------------------|----------------| +| Pakistan | PK | AS923_1 | AS923 | ✓ | +| Palau | PW | - | | Check Helium Explorer | +| Palestinian Territories | PS | - | | Check Helium Explorer | +| Panama | PA | AU915_SB1 | US915 and AS923 | ✓ | +| Papua New Guinea | PG | AS923_1 | US915 and AS923 | ✓ | +| Paraguay | PY | AU915_SB1 | US915 and AS923 | ✓ | +| Peru | PE | AU915_SB1 | US915 and AS923 | ✓ | +| Philippines | PH | AS923_3 | US915 | ✓ | +| Pitcairn Islands | PN | - | | Check Helium Explorer | +| Poland | PL | EU868 | EU868 | ✓ | +| Portugal | PT | EU868 | EU868 | ✓ | +| Puerto Rico | PR | US915 | US915 | ✓ | + +## Q + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------|--------------|---------------|-------------|-------| +| Qatar | QA | EU868 | EU868 | ✓ | + +## R + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|-------| +| Réunion | RE | EU868 | EU868 | ✓ | +| Romania | RO | EU868 | EU868 | ✓ | +| Russia | RU | RU864 | | ✓ | +| Rwanda | RW | EU868 | EU868 | ✓ | + +## S + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------------------------------|--------------|---------------|----------------------|----------------| +| Sahrawi Arab Democratic Republic | EH | - | | Check Helium Explorer | +| Saint Barthelemy | BL | EU868 | EU868 | ✓ | +| Saint Helena | SH | - | | Check Helium Explorer | +| Saint Kitts and Nevis | KN | AU915_SB1 | US915 and AS923 | ✓ | +| Saint Lucia | LC | AU915_SB1 | US915 and AS923 | ✓ | +| Saint Martin | MF | EU868 | EU868 | ✓ | +| Saint Pierre and Miquelon | PM | EU868 | EU868 | ✓ | +| Saint Vincent and the Grenadines | VC | AU915_SB1 | US915 and AS923 | ✓ | +| Samoa | | EU868 | EU868 | ✓ | +| San Marino | SM | EU868 | EU868 | ✓ | +| São Tomé and Príncipe | ST | - | | Check Helium Explorer | +| Saudi Arabia | SA | EU868 | EU868 | ✓ | +| Senegal | SN | EU868 | EU868 | ✓ | +| Serbia | RS | EU868 | EU868 | ✓ | +| Seychelles | SC | EU433 | | Check Helium Explorer | +| Sierra Leone | SL | EU868 | EU868 | ✓ | +| Singapore | SG | AS923_1 | AS923 | ✓ | +| Slovakia | SK | EU868 | EU868 | ✓ | +| Slovenia | SI | EU868 | EU868 | ✓ | +| Solomon Islands | SB | AS923_1 | AS923 | ✓ | +| Somalia | SO | EU868 | EU868 | ✓ | +| South Africa | ZA | EU868 | EU868 | ✓ | +| South Georgia and the South Sandwich Islands | GS | EU868 | EU868 | ✓ | +| South Korea | KR | KR920 | | ✓ | +| South Sudan | SS | - | | Check Helium Explorer | +| Spain | ES | EU868 | EU868 | ✓ | +| Sri Lanka | LK | AS923_1 | AS923 | ✓ | +| Sudan | SD | - | | Check Helium Explorer | +| Suriname | SR | AU915_SB1 | US915 and AS923 | ✓ | +| Svalbard and Jan Mayen | SJ | EU868 | EU868 | ✓ | +| Sweden | SE | EU868 | EU868 | ✓ | +| Switzerland | CH | EU868 | EU868 | ✓ | +| Syria | SY | EU868 | EU868 | ✓ | + +## T + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------|--------------|---------------|----------------------|----------------| +| Taiwan | TW | AS923_1 | AS923 | ✓ | +| Tajikistan | TJ | - | | Check Helium Explorer | +| Tanzania | TZ | AS923_1 | AS923 | ✓ | +| Thailand | TH | AS923_1 | AS923 | ✓ | +| Timor-Leste | TL | - | | Check Helium Explorer | +| Togo | TG | EU433 | | Check Helium Explorer | +| Tokelau | TK | AS923_1 | AS923 | ✓ | +| Tonga | TO | AU915_SB1 | US915 and AS923 | ✓ | +| Trinidad and Tobago | TT | AU915_SB1 | US915 and AS923 | ✓ | +| Tunisia | TN | EU868 | EU868 | ✓ | +| Turkey | TR | EU868 | EU868 | ✓ | +| Turkmenistan | TM | - | | Check Helium Explorer | +| Turks and Caicos Islands | TC | AU915_SB1 | US915 and AS923 | ✓ | +| Tuvalu | TV | - | | Check Helium Explorer | + +## U + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-----------------------------|--------------|---------------|--------------------|---------------| +| U.S. Minor Outlying Islands | UM | US915 | US915 | ✓ | +| U.S. Virgin Islands | VI | US915 | US915 | ✓ | +| Uganda | UG | EU868 | EU868 | ✓ | +| Ukraine | UA | EU868 | EU868 | ✓ | +| United Arab Emirates | AE | EU868 | EU868 | ✓ | +| United Kingdom | GB | EU868 | EU868 | ✓ | +| United States | US | US915 | US915 | ✓ | +| Uruguay | UY | AU915_SB1 | US915 and AS923 | ✓ | +| Uzbekistan | UZ | EU868 | EU868 | ✓ | + +## V + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------------------|--------------|---------------|--------------------|-------| +| Vanuatu | VU | AS923_3 | US915 | ✓ | +| Vatican City | VA | EU868 | EU868 | ✓ | +| Venezuela | VE | AS923_1 | AS923 | ✓ | +| Vietnam | VN | AS923_2 | AS923 | ✓ | +| Virgin Islands (UK) | VG | AU915_SB1 | US915 and AS923 | ✓ | + +## W + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------|--------------|---------------|--------------------|---------------| +| Wallis and Futuna | WF | EU868 | EU868 | ✓ | +| Western Sahara | EH | - | | Check Helium Explorer | + +## Y + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------|--------------|---------------|--------------------|---------------| +| Yemen | YE | - | | Check Helium Explorer | + +## Z + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|-------------|-------| +| Zambia | ZM | EU868 | EU868 | ✓ | +| Zimbabwe | ZW | EU868 | EU868 | ✓ | + +\* **Note for Eswatini, Lesotho, Malawi, and Mozambique:** TTN/CRASA references point toward EU863-870/EU433 for several SADC/CRASA countries, but the LoRaWAN regional parameters RP002-1.0.5 leave some of these blank or less explicit. We suggest using **EU868** for these countries, but recommend verifying with your local telecommunications regulatory body. + +:::info +Updated March 2025. +::: + +:::note +You can always contact us contact us through our [support](https://support.weatherxm.com) page for more information regarding devices without an exact frequency match to your country. +::: + +--- +# Assembling WS2000 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/helium/assemble +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/assemble.md + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (not included) +2. Metal wrench (not included) +3. Batteries 1.5V **not rechargeable** (x6 AA) (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need six (x6) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Battery installation diagram (external box) + + + +- **Step 1:** Slide the battery box lock switch to unlock position. Push to open the battery box door according to the arrow direction. +- **Step 2:** Insert the 6 AA batteries according to the +/- polarity indicated. +- **Step 3:** Place and lock the battery box door. + + + +- **Step 4:** Unscrew the battery door at the bottom of the weather station. +- **Step 5:** Insert the dummy battery to the battery compartment, make sure the +/- polarity is correct. +- **Step 6:** Replace the battery door which comes along with the external battery box, then tighten the battery door screw. + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not trying to charge the batteries, but only provides power to an internal super capacitor, +thus no point using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the weather station. +::: + +Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + +The primary power source for the weather station is the solar panel. When solar power is available (sun light) a super capacitor is charged +and is later used during night and when there is insufficient solar light. +In climates that frequently sustain temperatures below 0°C or 32°F the use of lithium batteries is recommended +as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### LED of sensor working status + +At the bottom of the weather station there are buttons and indicators: + + + + Once the batteries are inserted, the LED indicator on the back of the station should turn on for 4 seconds + and then flash every 16 seconds indicating that the station transmits the data. + +
+ +### Adjust the solar panel + +The tilting angle of the solar panel can be adjusted vertically from 0° into 15°, 30°, 45° and 60° positions depending on the area you are living in. For optimal power output year-round, +please set the tilt angle that is closest to your latitude. + +
+ +Set tilt angle of solar panel related to your location + +| Location ( latitude, longitude) | Solar panel tilt angle | +| ----------------------- | ------------------------ | +| Hamburg (53.558, 9.7874) | 60° | +| Chicago (42.1146, -88.0464) | 45° | +| Houston (29.7711, -95.3552) | 30° | +| Bangkok (14.2752, 100.5684) | 15° | +| Sydney (-33.5738, 151.3053) * | 0° | + +***Sensors installed in southern hemisphere must have their solar panels flat to ensure maximum solar efficiency.** + +
+ +
+ +
+ + + +:::danger +If the screw holding the solar panel is not released for the adjustment, there is a risk of breaking the plastic enclosure. +::: +:::caution +Do not remove solar panel protection film before assemble battery box properly. +::: + +- **Step 1:** Remove the solar panel protection film. +- **Step 2:** Loosen the screw lightly until the gears on the opposite side separated from lock position. +- **Step 3:** Adjust the vertical angle of the solar panel (0°, 15°, 30°, 45°, 60°) according to the latitude of your location. +- **Step 4:** Push the gear and tighten the screw until the gears are securely locked. + +--- +# Connect and Claim the Station +Canonical: https://docs.weatherxm.com/wxm-devices/helium/connect-and-claim +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/connect-and-claim.md + +The weather station receives all meteorological data and presents it on the screen of your smartphone. +In this chapter, you will find guidance to set up the WeatherXM Helium station. + +## Prerequisites + +1. The station must be fully assembled (parts and batteries) +1. A working smartphone with connection to the internet +1. The [WeatherXM](/wxm-devices/helium/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +## Step by Step Instructions + +### Preparation of weather station + + + + Τo check if the weather station is in operation, check the red LED at the bottom of the station, it should light up - continuously or briefly - as soon as you insert the batteries. + + + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Choose the device type + +:::info +if you experience connection issues while claiming a helium device, make sure you are near the station. +::: + + + + +#### Reset your weather station and select device to pair + +Push the reset button at the bottom of your WeatherXM device to enable bluetooth pairing. This will expire in 5 minutes. After that, you will need to push it again to restart the pairing process. +After that, push the "Pair station via bluetooth" button as seen in the picture below. + +![select device to pair](/img/wxm-devices/helium/select-device-to-pair.png) + + +
+ +### Confirm station installation location + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your WeatherXM station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to acknowledge the correctness of the installation location and then tap on "Confirm and Proceed" button. + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you select the location that you will install your station as precisely as possible, as this will take part in the quality of the data you will share with the network and thus your overall WXM rewards. +::: + + +
+ +### Set weather station operation frequency + + + + +For the weather station to operate properly, you need to set its frequency to match the Helium network frequency in your country. + +[A list of the countries and their respective frequencies can be found here](https://docs.helium.com/iot/lorawan-region-plans/). + +Given the location of installation you defined in the previous step, we’ve selected the appropriate frequency for that location. + +Once you've found the right frequency, tap on the checkbox to acknowledge the correctness of the installation and then tap on "Set & Claim" button. +That's it. You've now claimed your new WeatherXM station and you'll be able to see its data on your WeatherXM apps! + +All you need to do now, is to update your weather station to the latest firmware version. To do so, please follow the instructions in the chapter ["Update Firmware"](/wxm-devices/helium/update-firmware/). + +:::caution +The frequency selected above is the correct one the country you’ve installed and will operate this station. +::: + + +
+ +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: + +--- +# Box Contents WeatherXM Helium Station (WS2000) +Canonical: https://docs.weatherxm.com/wxm-devices/helium/contents +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/contents.md + +## Included + + + +

Included in the box

+
    +
  1. WeatherXM Helium weather station
    2. +
  2. External battery box
    3. +
  3. Metal zip ties
    4. +
+ + +:::info +Initial quantities included a short plastic pole accessory that was intended to be used with a wooden log to increase the total pole height to 2m. It was discovered that this accessory was not being utilised effectively, so it was removed from subsequent batches. +::: + +
+ +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x6 AA) +1. Metal mounting pole (recommended 40mm/1.57in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +### Weather Station + +The weather station is a set of sensors encased in a plastic shell that ensures the proper function of the device. + +The weather station is responsible for the collection of measurements of temperature, humidity, rain rate, wind speed, wind direction, atmospheric pressure and UV index. + + + +

Components

+ +
    +
  1. Rain gauge
    2. +
  2. Balance indicator
    3. +
  3. UV and light intensity sensor
    4. +
  4. Wind vane
    5. +
  5. Wind cups
    6. +
  6. Antenna
    7. +
  7. Solar panel
    8. +
  8. Radiation shield, temp/humidity, barometric pressure sensor
    9. +
  9. Drain holes
    10. +
  10. Built-in battery box
    11. +
  11. Red LED indicator
    12. +
  12. Config button
    13. +
  13. Mounting clamp
    14. +
  14. Adjustable hinge of solar panel
    15. +
  15. Tipping bucket
    16. +
  16. Rain sensor
    17. +
+ + +:::note +For further details about an advisable installation of the weather station, please see [Installing the WeatherXM Helium station (WS2000) Weather Station](/wxm-devices/helium/install-weather-station). +::: +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. + +--- +# Installing WS2000 Weather station +Canonical: https://docs.weatherxm.com/wxm-devices/helium/install-weather-station +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/install-weather-station.md + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing [Best Practices for Proper Station Installation](/wxm-devices/helium/install-weather-station#best-practices-for-proper-station-installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + +## Best Practices for Proper Station Installation + +It is very important that your weather station collects quality measurements. +This turns the weather station into a powerful tool for yourself and WeatherXM. + +The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles +and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: + +:::info +Not sure of your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). +::: + +### Pole's Height +The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. +This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal +or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + + + + +
+ +### Tighten Pole +The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds. +This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements. + + + +
+ +### Installation Point + +The pole together with the weather station should be placed in an installation point, which: + +

1. Is away from heat sources

+Is not affected by the air or smoke flowing out of any chimney or ventilation system +(as an illustration, consider that wind of a certain direction may move warm smoke towards the station). +An advisable distance from a heat source is >5 meters/16.4ft. + +
+ +
+ +

2. Does not get in shadowed areas

+Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item). +
+ + + + +
+ +

3. Adequate Distance

+Has a distance from any obstacle around, which 2-4 times larger than the height of the highest obstacle +(e.g., if the highest obstacle around the installation point is a 6m/20ft tree, ht=6m/20ft, +and the pole of the weather station is 2m/6.56ft, hp=2m/6.56ft, then the pole should be placed at a distance (dp) of 8-16m/26-52ft, +2 x (ht-hp) < dp < 4 x (ht-hp). In case the pole is placed on a building’s roof, +then the building’s height should be added to the pole’s height). +Note that in cases of obstacles with a height >8m/26ft, you should consider placing the weather station +at a distance 30 times the width and 15 times the height of the obstacles around. + +:::note +All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible +while 3. is important for avoiding faulty precipitation and wind measurements. +::: + +
+ +### Direction Alignment + + + + Install the weather station in an open location with no obstructions above and around the + sensor for accurate rain and wind measurement. + Locate the North (N) marker on top of the weather station and align the marker to point North + upon final installation with a compass or GPS. Tighten the mounting bracket around a 30-40mm + or 1.1-1.57in diameter pole (not included) using the two screws and nuts provided. + Use the bubble level on the weather station to make sure the sensor is completely level for + proper measurement of precipitation, wind direction, UV and light intensity. + +--- +# Introduction WeatherXM Helium station (WS2000) +Canonical: https://docs.weatherxm.com/wxm-devices/helium/introduction +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/introduction.md + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 6 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to the Helium network and claim it as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Add your ERC20 compatible wallet + +In order to receive $WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WS2000 Weather Station (Helium) + + + + + +Powered via a small solar panel. +The maximum communication distance is 2 to 10km depending on the environment. + +- #### Air Temperature: + + - Range: -40.0 - 80.0 °C + - Accuracy: ±0.5 °C (0 - 80 °C) ±0.6 °C (-40 - 0 °C) + - Resolution: 0.1 °C + +- #### Air Humidity: + + - Range: 1 - 99% RH + - Accuracy: ±3% (1 - 90% RH) ±4% (90 - 99% RH) + - Resolution: 1% RH + +- #### Rain Hourly Rate: + + - Range: 0 - 450 mm/h + - Accuracy: ±7% + - Resolution: 0.254 mm/h + +- #### Barometric Pressure: + + - Range: 540 - 1100 hPa + - Accuracy: ±5 hPa(700 - 1100 hPa) ±8hPa (540 - 699 hPa) + - Resolution: 1 hPa + +- #### Wind Speed: + + - Range: 0 - 50.0 m/s + - Accuracy: ±0.5 m/s ({'<'}5 m/s) ±10% ({'>'}5 m/s) + - Resolution: 0.1 m/s + +- #### Wind Direction: + + - Range: 0 - 360° + - Accuracy: ± 8° + - Resolution: 1° + +- #### Light Intensity: + + - Range: 0 - 200000 lux + - Accuracy: ± 5% + - Resolution: 1 lux + +- #### UV Index: + + - Range: 0 - 16.0 + - Accuracy: ±10% + - Resolution: 0.1 + +

General Parameters

+ +- #### Operating Temperature: + - -20 to +60 °C (Use of alkaline batteries suggested) + - -40 to +60 °C (Lithium battery) + +- #### Operating Humidity: + + - 0 - 99% RH + +- #### Device Weight: + + - 1.5 kg + +- #### Certification: + + - CE / FCC / RoHS + +- #### Solar Panel: + + - 0.5W (When there is sunlight, solar panels will be used first, otherwise batteries will be used) + +- #### Battery Type: + + - AA size, 1.5 V batteries (alkaline or non-rechargeable Lithium battery) + +- #### Number of batteries: + + - External battery box: x6 AA batteries + +- #### Battery Life: + + - 1 year (solar panel with external battery box, 20 uplinks / hr) +- #### External Battery Box: + + - Support x6 AA 1.5V batteries + - Cable length: 2 m + - IP Rating: IPX6 + +##### * The battery life varies from data upload interval and distance between gateway. + + + + + +Powered via a small solar panel. +The maximum communication distance is 1.2 to 6.2 mi depending on the environment. + +- #### Air Temperature: + + - Range: -40.0 - 176.0 °F + - Accuracy: ±0.5 °F (0 - 176 °F) ±0.6 °F (-40 - 32 °F) + - Resolution: 0.1 °F + +- #### Air Humidity: + + - Range: 1 - 99% RH + - Accuracy: ±3% (1 - 90% RH) ±4% (90 - 99% RH) + - Resolution: 1% RH + +- #### Rain Hourly Rate: + + - Range: 0 - 17.7 in/h + - Accuracy: ±7% + - Resolution: 0.01 in/h + +- #### Barometric Pressure: + + - Range: 540 - 1100 hPa + - Accuracy: ±5 hPa(700 - 1100 hPa) ±8hPa (540 - 699 hPa) + - Resolution: 1 hPa + +- #### Wind Speed: + + - Range: 0 - 111.8 mph + - Accuracy: ±0.5 mph ({'<'}11.1mph) ±10% ({'>'}11.1 mph) + - Resolution: 0.1 mph + +- #### Wind Direction: + + - Range: 0 - 360° + - Accuracy: ± 8° + - Resolution: 1° + +- #### Light Intensity: + + - Range: 0 - 200000 lux + - Accuracy: ± 5% + - Resolution: 1 lux + +- #### UV Index: + + - Range: 0 - 16.0 + - Accuracy: ±10% + - Resolution: 0.1 + +

General Parameters

+ +- #### Operating Temperature: + - -4 to +140 °F (Use of alkaline batteries suggested) + - -4 to +140 °F (Lithium battery) + +- #### Operating Humidity: + + - 0 - 99% RH + +- #### Device Weight: + + - 3.3 lb + +- #### Certification: + + - CE / FCC / RoHS + +- #### Solar Panel: + + - 0.5W (When there is sunlight, solar panels will be used first, otherwise batteries will be used) + +- #### Battery Type: + + - AA size, 1.5V batteries (alkaline or non-rechargeable Lithium battery) + +- #### Number of batteries: + + - External battery box: x6 AA batteries + +- #### Battery Life: + + - 1 year (solar panel with external battery box, 20 uplinks / hr) + +- #### External Battery Box: + + - Support x6 AA 1.5V batteries + - Cable length: 6.5 ft + - IP Rating: IPX6 + +##### * The battery life varies from data upload interval and distance between gateway. + + + + + +--- +# Maintenance of WeatherXM Helium station (WS2000) +Canonical: https://docs.weatherxm.com/wxm-devices/helium/maintenance +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/maintenance.md + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/helium/contents#weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: + +--- +# Troubleshooting of WeatherXM Helium station (WS2000) +Canonical: https://docs.weatherxm.com/wxm-devices/helium/troubleshooting +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/troubleshooting.md + +:::info +**if you experience connection issues while claiming a WeatherXM Helium station, make sure you are near the station.** +::: + +### The updating process lasts forever + +If the process hangs and does not proceed or if pairing fails, try a [factory reset](/wxm-devices/helium/troubleshooting#factory-reset). + +
+ +### Asks to pair but fails + + + +Restart your station. Pairing is only allowed in the first 5 minutes after the station is started. After 5 minutes the station refuses pairing. If the problem persists, do a [factory reset](/wxm-devices/helium/troubleshooting#factory-reset) and try again. + +
+ +### No location (GPS) data + + + +If your station reports "No location data" please make sure your station is installed properly as per the installation instructions. + +:::note +Your station reports its location a few times per day depending on network and battery status and thus it might take some time until the location is confirmed by the WeatherXM platform. +::: + +
+ +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +
+ +### My station is not detected during scanning + + + + +Make sure the device has started. Press the reset button at the bottom of the weather station. The light at the bottom of the station will flash a few times indicating that the restart was successful. +If it continues to go undetected, try scanning again from a closer distance. The operating bluetooth range of the station is around 10m/32ft with few obstacles. + +
+ +### The process does not start or is stopped before it is completed + + + + +Close the application and start the process again. If the problem persists, press the reset button at the bottom of the weather station and try again. Finally, try doing a factory reset. + +
+ +### The app cannot connect to the station after successfully pairing + + + + If the claiming process is repeated more than twice without completion, attempt to unpair your weather station and start over. If you encounter connection problems during the claiming, make sure that you are near to the weather station at all times. The solution to the above is to visit the Bluetooth settings of the mobile phone, find the station in the paired devices and "forget the device". This flow is different on Android and iOS. + + +

How to forget/unpair your device

+ + + + + + + + + + + + + + + + + + + + +### Factory reset + + + +During factory reset all settings are reverted to the factory state, this includes the **frequency** configuration as well as the erasing of all **bonded mobile devices**. + +The erasing of the bonding information from the station results in the station "forgetting" all the mobile devices that have paired to it, so they will not be able to connect to the station anymore as they still hold old bonding data that is now outdated. In order to be able to pair with the station again **the station must be unpaired on the mobile device as well**, by removing it from the Bluetooth paired devices menu. + +:::warning +It is recommended to unpair the station from your mobile device's bluetooth menu, **right before** performing the factory reset. This ensures you’ll be able to successfully pair again after the reset, during which the station will reboot and remain in pairing mode for a few minutes. +::: + +After factory reset is complete and the station is paired to the mobile device again, the **frequency** needs to be set to the proper frequency used in your region via the station settings menu on your app or your station will not be able to join the network. + +To perform the factory reset, hold down the middle button on the bottom of the weather station, count to ~10 and release. The LED will start flashing very quickly as an indication that the factory reset has succeeded and then the station will restart. + +## Other Issues + +### How to see if there is Helium coverage in your area. + +You can check the Helium coverage in your location by either using [Hotspotty](https://app.hotspotty.net/hotspots/statistics) or [Helium's Explorer](https://explorer.helium.com/). + +
+ +### Can a WeatherXM Helium station paired with more than one device? + +Yes, it can be paired with multiple devices. + +
+ +### In order for the WeatherXM Helium stations to work, should they be in a Helium hexagon or the principle is the same as for the WiFi stations? + +WeatherXM Helium weather stations transmit data by using the helium network. In order to work properly they should be in a place where there is Helium coverage. + +
+ +--- +# Update Firmware +Canonical: https://docs.weatherxm.com/wxm-devices/helium/update-firmware +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/update-firmware.md + +### Prepare device for firmware update + +:::info +if you experience connection issues while claiming a WeatherXM helium device, make sure you are near the station. +::: + + + +In order for your station to keep operating normally and receive WXM rewards, you must update the station. + +The process is done wirelessly via bluetooth and requires you to be at a distance of ~{'<'}10m/32ft from the station. + +This document describes the firmware update process using an Android smartphone, the process for iOS is similar. + +Push the reset button at the bottom of your WeatherXM device to enable bluetooth pairing.This will expire in 5 minutes. After that, you will need to push it again to restart the pairing process. + +:::note +Your mobile phone must be paired to your weather station for the mobile app to be able to communicate with it. This procedure needs to take place only once. All further communications do not require any pairing as your weather station stays paired to your mobile phone as long as it was not factory reset or the pairing manually removed in your phone. +::: + +:::caution +Make sure you don't move away from your station as you might lose bluetooth connection. +::: + +
+ +### Installing update + + + + +:::info +if you experience connection issues while claiming a WeatherXM helium device, make sure you are near the station. +::: + +:::caution +**Do not switch off the application!** + +Make sure you don't move away from your station as you might lose bluetooth connection. +::: + + +
+ +### Successful firmware update + + + + +That's it! You've now claimed your new WeatherXM station and you'll be able to see its data on your WeatherXM app! + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +--- +# installation-best-practices-ws100x +Canonical: https://docs.weatherxm.com/wxm-devices/installation-best-practices-ws100x +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/installation-best-practices-ws100x.md + +## Best Practices for Proper Station Installation + +It is very important that your weather station collects quality measurements. +This turns the weather station into a powerful tool for yourself and WeatherXM. + +The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles +and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: + +:::info +Not sure of your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). +::: + +### Pole's Height +The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. +This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal +or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + + + + + + +
+ +### Pole specifications + + + The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. + This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal + or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + +
+ +### Tighten Pole +The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds. +This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements. + + + +
+ +### Installation Point + +The pole together with the weather station should be placed in an installation point, which: + +

1. Is away from heat sources

+Is not affected by the air or smoke flowing out of any chimney or ventilation system +(as an illustration, consider that wind of a certain direction may move warm smoke towards the station). +An advisable distance from a heat source is >5 meters/16.4ft. + +
+ +
+ +

2. Does not get in shadowed areas

+Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item). +
+ + + + +
+ +

3. Adequate Distance

+Has a distance from any obstacles around, which 2-4 times larger than the height of the highest obstacle +(e.g., if the highest obstacle around the installation point is a 6m/20ft tree, ht=6m/20ft, +and the pole of the outdoor sensor is 2m/6.5ft, hp=2m/6.5ft, then the pole should be placed at a distance (dp) of 8-16m/26-52.5ft, +2 x (ht-hp) < dp < 4 x (ht-hp). In case the pole is placed on a building’s roof, +then the building’s height should be added to the pole’s height). +Note that in cases of obstacles with a height >8m/26ft, you should consider placing the outdoor sensor +at a distance 30 times the width and 15 times the height of the obstacles around. + +:::note +All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible +while 3. is important for avoiding faulty precipitation and wind measurements. +::: + +--- +# Assembling WS1000 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/m5/assemble +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/assemble.md + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) + and another that measures the wind direction (though wind vane). + Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, + which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. + The wind vane should be placed on the shaft at the bottom of the sensor. + After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 20 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG1000 gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: +
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). + +
+ +--- +# Connect and Claim the Gateway +Canonical: https://docs.weatherxm.com/wxm-devices/m5/connect-and-claim +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/connect-and-claim.md + +## WG1000 Gateway + + + + + + + + + +The weather station comes together with the WG1000 Gateway. +The WG1000 Gateway receives all the meteorological data, which are measured and transmitted every 16 seconds by the outdoor sensor +and displays them on its screen. + +In this chapter, you will find guidance to set up the WG1000 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. The [WeatherXM](//wxm-devices/m5/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +1. A reliable 2.4 GHz WiFi network (5 GHz is not supported) for the WG1000 Gateway to connect to. + +
+ +## Step by Step Instructions + +### Connect GPS antenna + + + + Attach the GPS antenna to WG1000 Gateway. You should hear a "click" when it's properly installed. + + +
+ +### Connect M5 Gateway to power source and turn device on + + + + The WG1000 Gateway must be connected to a power source at all times. + It has a limited battery, but you should not rely on it. + + +:::caution +If WG1000 Gateway turns off, you will not receive $WXM rewards, as you will not be able to share data with the WeatherXM network. **This will result in no WXM rewards!** +::: + + +
+ +### Place WG1000 Gateway near a window (for better GPS signal) + + + +For better GPS signal, it's highly recommended to place the WG1000 Gateway device near a window. Make sure that it has a good GPS coverage at all times. + +:::note +This step could take some time till the device connects to GPS satellites. +::: + +:::caution +If the GPS signal is lost, you could receive less WXM rewards (or none). This is because we will not be able to verify your location. +::: + + +
+ +### Change Frequency (Optional) + + + + + + + + + + + + +The WG1000 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 2 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency + + + + +
    +
  1. Swipe right on the touch screen
    2. +
  2. Click the Frequency options and select the new frequency your WG1000 Gateway will listen to
    3. +
  3. A confirmation dialog will open. Read it carefully and click "Continue" or "Cancel" accordingly
    4. + +
+ + + +
    +
  1. Swipe left on the touch screen
    2. +
  2. Click the Frequency options and select the new frequency your WG1000 Gateway will listen to
    3. +
  3. A confirmation dialog will open. Read it carefully and click "Yes" or "No" accordingly
    4. +
+ + + +:::caution +If you don't use the correct frequency as your weather station, WG1000 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Connect WG1000 Gateway to WiFi + + + + + +By now, your WG1000 Gateway is set and ready for claiming! +- Swipe right to navigate to the settings screen. There, tap on "Configure WiFi" to switch to connect mode. +- An Access Point will be created with SSID "WXMMinerM5", you should connect to it from your smartphone. +- Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +- Enter your WiFi credentials and click "Save" +- WG1000 Gateway will restart and connect to your WiFi network + +A popup will open, asking you to select the desired network you'd like to connect the WG1000 Gateway. Select the one you want and provide the password for it. + + + + +By now, your WG1000 Gateway is set and ready for claiming! +- Swipe right to navigate to the settings screen. There, tap on "Configure WiFi" to switch to connect mode. +- An Access Point will be created with SSID "WXMMinerM5", you should connect to it from your smartphone. +- Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +- Enter your WiFi credentials and click "Save" +- WG1000 Gateway will restart and connect to your WiFi network + +A popup will open, asking you to select the desired network you'd like to connect the WG1000 Gateway. Select the one you want and provide the password for it. + + + +:::note +Once the WiFi credentials have been successfully transferred to WG1000 Gateway, the device will restart and the WiFi icon will turn green! +::: +:::note +While you are connected to the "WXMMinerM5" network, you will not have internet access. +::: + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### How to properly configure your WG1000 Gateway's WiFi network step by step (Video) + + + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Type the WG1000 Gateway serial number when prompted + + + + +#### Navigate to WG1000 Gateway and find the device's Serial Number + +Follow the steps shown in the image below to find your WG1000 Gateway's Serial Number. You'll need to type this in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + + + + + + + + + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: + +--- +# Box Contents of M5 bundle (WB1000) +Canonical: https://docs.weatherxm.com/wxm-devices/m5/contents +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/contents.md + +## Included + + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Metal plate
    5. +
  5. U-bolts (x2)
    6. +
  6. Nuts (x4)
    7. +
  7. Wrench
    8. +
  8. Screwdriver
    9. +
  9. Allen key
    10. +
  10. WG1000 Gateway
    11. +
  11. External RF Antenna
    12. +
  12. Reset jumper (not included in very early models)
    13. +
  13. GPS antenna
    14. +
  14. Power supply cable (USB-C)
    15. +
+ + +:::danger +The reset jumper (#12 above) is used for recovery purposes and troubleshooting. Do not connect it to your WG1000 Gateway unless instructed by support or you know what you're doing. +Using it without proper reason may result in loss of data which will affect your rewards. +::: + +
+ +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole +1. USB power supply + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 16 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1000 Weather Station](/wxm-devices/m5/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG1000 Gateway + + + +The WG1000 Gateway is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via WiFi to IPFS and the WeatherXM network. + +The WG1000 Gateway is advised to be placed indoors, in an environment of relatively constant temperature (ideally within a daily range of <4°C/7°F for proper functioning of the barometer), +near a window (for better GPS signal). + +The WG1000 Gateway should be permanently connected to power and powered on in order to be able to receive, record and upload measurements to the Internet. + +The above graph shows the location of the buttons and the needed connections. Briefly, there is a power and a reset button, a port for the GPS antenna and a USB Type-C port for power supply. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. + +--- +# Installing WS1000 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/m5/install-weather-station +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/install-weather-station.md + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +### Video Instructions with Dr. Keppas + +[![Instruction on how to install the WG1000 Gateway WeatherXM weather station](/img/wxm-devices/m5/video-setup-installation.png)](https://www.youtube.com/watch?v=J-dSXNLX4nk&ab_channel=WeatherXM) + +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ Thus, it is important that you are able to read all the measurements on the WG1000 Gateway's screen, + while you keep the outdoor sensor nearby (preferably not closer than 1.5m/5ft from the WG1000 Gateway though).
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. + +--- +# Introduction of M5 bundle (WB1000) +Canonical: https://docs.weatherxm.com/wxm-devices/m5/introduction +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/introduction.md + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG1000 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive $WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG1000 Gateway + +- Capacitive touch screen +- ATECC608 hardware encryption +- GPS + BLE + RF +- Forwards weather data via WiFi +- Powered by USB +- Over-the-air firmware upgradable + +### WS1000 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG1000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1000 Gateway is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 16 seconds + + + + + +Powered via a small solar panel and batteries and communicates with the WG1000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1000 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 16 seconds + + + + + +--- +# Maintenance of WS1000 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/m5/maintenance +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/maintenance.md + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG1000 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/m5/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: + +--- +# Troubleshooting of M5 bundle (WB1000) +Canonical: https://docs.weatherxm.com/wxm-devices/m5/troubleshooting +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/troubleshooting.md + +## Weather Station + +### Weather station not reporting data to WG1000 Gateway. There are dashes (--) on the display console. + +First make sure you WG1000 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/m5/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/m5/contents#outdoor-weather-station)) for flashing. +The LED should flash every 16 seconds. + +If the LED is not flashing every 16 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors, or the WG1000 gateway has not been reset. +The solution may be as simple as powering down and up the WG1000 Gateway. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG1000 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. +1. WG1000 Gateway should display all the observations measured by the weather station. +1. Try to place the WG1000 Gateway at the desirable point and check that it receives data. + Ensure the power adapter if used is not too close to the WG1000 Gateway and the WG1000 Gateway is not close to other electrical noise generating devices + such as TVs, monitors, computers and transmitting devices. +1. If you still have intermittent problems, move the weather station and the WG1000 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft if you use the internal (external) RF antenna. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG1000 Gateway. + Relocate the weather station and WG1000 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. +1. Use the external RF antenna provided with M5, but this requires you open the WG1000 Gateway (Read more on the bottom of this page). + +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by (see [Best Practices for Proper Station Installation](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation)). + +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +### One or more variables are extremely high, low, or constant for long periods of time. + +Change the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +### Pressure on WG1000 Gateway appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +## WiFi Connectivity + +### No WiFi connection + +Check for the WiFi symbol on the top-right corner of the display. + +- If wireless connectivity is operational, the WiFi icon will appear in green. +- If the symbol appears in red, but you do remember configuring it successfully before, check that the WG1000 Gateway and Internet router are close enough. + +If you have never been able to configure WiFi to a working state, make sure your WiFi supports 2.4 GHz signals. The console does not support WiFi that uses the 5 GHz spectrum. + +Make sure you configured the correct SSID and password. Repeat the procedure if necessary to verify. + +
+ +### Wifi Repeater +Usually, using a WiFi repeater is not an issue, but in some cases it may affect your WG1000 Gateway’s connection. If you are experiencing issues with your M5, try to connect it directly to your router and see if the problem persists. If it does not, +then the issue is with the repeater. If it does, please contact us through [support](https://support.weatherxm.com). + +
+ +### WG1000 Gateway not working in 5 GHz WiFi. +WG1000 Gateway is designed to work **only** at the 2.4GHz frequency. Please make sure the 2.4Ghz band on your router is enabled. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### I don't see the Wi-Fi name "WXM MinerM5" for initial setup on the app. + +It might take some time and attempts for it to connect. Please make sure that your Wi-Fi supports 2.4 GHz signals. You may also need to try from a different phone. You can also watch our instructional [video](https://www.youtube.com/watch?v=sUJEwuFq1CE). + +
+ +## GPS Location + +### No location (GPS) data (Arrow icon is red) +If the GPS (arrow) icon on your M5's UI is red, it means that there is no GPS signal: + + + + + + + + + + +Make sure your GPS antenna is firmly connected to the right connector: + +And then proceed to the following steps: + +1. Move your WG1000 Gateway outdoors (with the GPS antenna connected) + for a couple of minutes until the GPS icons becomes green. +1. Then, move WG1000 Gateway indoors placing the GPS antenna next to a window. + +If the problem remains, make sure the external antenna is selected in your M5's GPS stack (Read more on the bottom of this page). + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## My Station does not connect to the WG1000 Gateway + + [![Instruction on how to switch to RF antenna](/img/wxm-devices/m5/m5-video-lorawan.png)](https://www.youtube.com/watch?v=FP4rT3FTz0M&) + + +If the installation of the station and the placement of the WG1000 Gateway is more than 50m/~160ft apart, you must install the RF antenna so that the two can communicate over such distance. +Please follow the instructions below, or in the video. + +:::caution +If the station and WG1000 Gateway are more than 50m/164ft apart, you must install the RF antenna. Else the station might not be able to properly communicate with WG1000 gateway, resulting in less to none data being shared to the network, and thus reduce WXM rewards. +::: + +
+ +WG1000 Gateway RF Antenna Installation Instructions + +#### WG1000 Gateway Antenna Troubleshooting + +WG1000 Gateway is equipped with two antennas, the GPS and the RF. The GPS antenna is used to determine the location (coordinates) and altitude of the weather station, +while the RF antenna is responsible for the communication between the WG1000 Gateway and the weather station. + +On the left side of the WG1000 Gateway you may notice that there are two different caps, a grey for GPS and a blue for RF (labeled as "LoRa" in the cap). +Each of these caps contains a system relevant to the antennas mentioned above. + +By default, the external GPS antenna and the internal RF antenna are connected, and there is no need to modify this. + +The antenna plugs are VERY SENSITIVE so it is NOT recommended to switch cables unless there is a serious problem. + +#### Switch external/internal GPS antenna + +The WG1000 Gateway uses by default the external GPS antenna, which should be connected to the port on the grey GPS cap, +In case you desire to change the internal/external GPS antenna, follow the following steps: + +1. Unscrew and remove the four screws behind the WG1000 Gateway. +1. Remove the first cap. You may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. You will notice two small cables, one coming from the port on the side and one coming from a small chip. + Remove the cable, which is connected to a specific reception on the green board and connect the desired cable to the same reception. +1. Clasp the cap back and screw the device. +1. In case you changed to the external GPS antenna, connect the external antenna to the corresponding port on the side of the WG1000 Gateway. + +#### Switch external/internal RF antenna + +The WG1000 Gateway beta v1 uses by default the internal RF antenna. +In case you desire to change the internal/external RF antenna, follow the following steps: + +1. Unscrew and remove the four screws behind the WG1000 Gateway. +1. Remove the first cap. You may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. Remove the grey GPS cap. Again you may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. You will notice two small cables, one coming from the port on the side and one coming from an edge of the green board. + Remove the cable, which is connected to a specific reception on the green board and + connect the desired cable to the same reception. +1. Clasp the caps and the cap back and screw the device. +1. In case you changed to external RF antenna, connect the external antenna to the corresponding port on the side of the WG1000 Gateway (LoRa cap). + +##### Internal parts of the WG1000 Gateway + +a. Bottom is the first cap you remove once the WG1000 Gateway is unscrewed. + +b. The second cap in grey is the GPS + +c. The third cap in blue is the RF Connection to the weather station + +d. Top cap in white is the rest of WG1000 Gateway. + + + +
+ +## Other Issues + +### My WG1000 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### What can I do if my WG1000 Gateway is switching off frequently? + +Please disconnect the WG1000 Gateway from the power source, let it turn off by itself and reconnect it after 15-20 minutes. You can also try using a different USB cable and another wall adapter. If none of the previous work, try removing the four screws of the M5 bundle, separate the stacks and tighten the screws again. + +
+ +### Why is my station showing offline? + +Assuming that the WG1000 Gateway unit is powered on, this may be due to a bad internet connection or bad RF connection between the WG1000 Gateway and the outdoor station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: + +--- +# Updating Your WXM-M5 Firmware with the Flasher Tool +Canonical: https://docs.weatherxm.com/wxm-devices/m5/usb-flasher +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/m5/usb-flasher.md + +

Introduction

+If you are currently using a WG1000 Gateway with firmware version 0.3.12, it's essential to update your device using the Flasher Tool. This version is considered obsolete and cannot receive updates through the "Over The Air" (OTA) method any longer due to significant differences in the underlying operating system. To ensure your WXM-M5 continues to operate efficiently and receive rewards, you must perform a full firmware flash using a USB cable. +This guide will walk you through the step-by-step process of updating your WG1000 Gateway to the latest firmware version, ensuring you stay up to date with the latest features, security enhancements and continue to receive rewards. + +:::tip +To check the version of your WXM-M5, swipe to the left-most screen (about). If your version is newer than 0.3.12 you do not need to proceed with this update as your device will receive updates automatically. +::: + +:::danger +Support for WG1000 Gateway devices running v0.3.12 will be discontinued from November 2023 and they will cease to receive rewards shortly thereafter. It is important to follow the instructions on this page to update your device. +::: + +

How to Update Your WG1000 Gateway

+Follow these instructions carefully to update your WG1000 Gateway's firmware using the Flasher Tool. We've included screenshots to help you navigate the process. +Step 1: Prepare Your Equipment +Before starting, ensure you have the following: +
    +
  • A WG1000 Gateway powered on, running firmware version 0.3.12
    • +
  • A USB Type-C cable to connect your WG1000 Gateway to your computer
    • +
  • A computer running the Flasher Tool
    • +
+ +Step 2: Launch the Flasher Tool + + ![Launch Flasher Tool](image) + +
    +
  1. Download and install the Flasher Tool for your OS
    2. + Under Assets select: +
    1. Windows: `weatherxm_m5_flasher_*.exe`
      2. +
    2. Linux: `weatherxm_m5_flasher_*.deb`
    +
  2. Open the Flasher Tool on your computer
    3. +
+ +:::tip +If any device is found under the Serial port, temporarily unplug it before continuing. +::: + + +Step 3: Connect your WG1000 Gateway + + ![Connect Your WXM-M5](image) +
    +
  1. Plug one end of the USB cable into your computer's USB port
    2. +
  2. Plug the other end of the USB cable into your WXM-M5. If your WG1000 Gateway was off, it will turn on automatically.
    3. +
+ +Step 4: Select your WG1000 Gateway + + ![Select Your WXM-M5](image) + + In the Flasher Tool under "serial port", you can see all the devices connected to the virtual serial ports on your computer. Confirm that the port of your WG1000 Gateway is selected. Usually the device with the largest suffix number is the one that was connected more recently. + +:::note +Serial port name may differ depending on your OS. +::: + + +Step 5: Start the Update Process + + ![Start the Update Process](image) + +
    +
  1. Double-check that your WG1000 Gateway is connected to your computer via USB
    2. +
  2. Click on the "Update" button in the Flasher Tool
    3. +
+ +:::danger +Do not disconnect the USB cable until the update is successfully completed +::: + + +Step 6: Wait for Completion +The Flasher Tool will now update your WXM-M5's firmware. Please wait patiently for the process to finish. + +:::danger +Do not disconnect the USB cable until the update is successfully completed +::: + +Step 7: Verify the Update +Once the update is complete, your WG1000 Gateway will restart automatically. You can verify the successful update by checking the firmware version on the WXM-M5's screen. + +:::note +If your WG1000 Gateway did not restart automatically, press and hold the power button until it turns off and then power it back on. +::: +

Troubleshooting

+

Windows

+The flasher tool runs on Windows 10/11. Windows 7 is not supported. +When you run the tool, you will be greeted by the "Windows prevented an unrecognised application from running.". This is because the binary is not signed. Click More Info > Run Anyway to proceed. +

When I connect my WG1000 Gateway no ports appear.

+First, check if your USB cable is not damaged. It is recommended to try another cable to get this out of the way. If your WG1000 Gateway still doesn't appear in the port list, open Device Manager and check under "Ports (COM & LPT)". If no devices appear in the list your cable is most likely damaged. If a device with an exclamation mark appears or is in any other kind of erroneous state, your computer most likely lacks the USB drivers. Download and install the drivers from the USB chip manufacturers' website. +

I get an error about VCRUNTIMEXXX.dll missing

+Your windows installation is missing the MSVC runtime libraries. Download and install them from Microsoft's website. It is recommended to install both the x86 and x64 versions. + +

Linux

+Tested only on Debian based distributions. +If you encounter issues during the flashing process, follow these steps: +
    +
  1. If flashing fails immediately after pressing the "update" button, it may be due to insufficient privileges to access the serial port. In Debian-based distributions, run the following command to add your user to the appropriate group: +sudo adduser $USER dialout +After running this command, log out and then log back in, and retry the update process. If the issue persists, try running the Flasher Tool with sudo: +sudo /opt/wxm_m5_flasher/run.sh
    2. +
+If you have any further questions or encounter any issues during the update process, don't hesitate to reach out to our support team for assistance. We are here to help you keep your WG1000 Gateway up to date and running smoothly.

+ Be sure to include the contents of your log file for further analysis. To access the log file, click "Log" in the top right corner of the Flasher Tool window. + +--- +# Assembling WS1001 Weather Station +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/assemble +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/assemble.md + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + +The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) +and another that measures the wind direction (though wind vane). +Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, +which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. +The wind vane should be placed on the shaft at the bottom of the sensor. +After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 16 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG3000 Gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: +
+ +### External Battery pack installation + +While not mandatory, we strongly recommend the installation of the battery pack for the following reasons: + + 1. Extended Battery Life: Utilising only two batteries will result in the station depleting its power within 3 to 5 months, depending on environmental conditions. Installing the battery pack increases the battery life by approximately four times, significantly reducing the frequency of battery replacements. + 2. Improved Accessibility: The battery pack includes an extension cable (~3 meters), providing easier access for battery replacement when needed. + + + + 1. Open the Battery Pack: Begin by pulling the clip on the side of the battery pack to open it. + 2. Access the Battery Base: Gently pull out the battery base. You will see eight battery sockets arranged in groups of two (two pairs in the front and two in the back). + 3. Insert the Batteries: Place a battery in each socket, ensuring correct polarity alignment. + 4. Reassemble the Battery Pack: Carefully place the battery holders back into their original positions, ensuring they are oriented correctly (i.e., the cable should remain at the bottom and should not be twisted). + 5. Secure the Battery Pack: Close the lid of the battery pack and push the clip until it clicks into place. + 6. Prepare the Weather Station: On the weather station, remove the battery cover. + 7. Insert Dummy Batteries: Insert the dummy batteries into the station as you would with regular batteries, ensuring correct polarity. + 8. Close the Weather Station Cover: Close the embedded lid on the weather station and fasten the screw securely. + 9. Mount the Battery Pack: The battery pack can be attached to a pole using the two provided zip ties. + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing Bird Spikes +The bird spikes are designed to be installed on the rim of the rain cup to deter birds from perching on or around +the rain cup. + +#### Included Components + +Each weather station comes with the following bird spike components: + +- Metal Spikes +- Rim-Mounted Spike Holders: These are designed to fit around the edge of the rain cup. +- Metal Zip Ties: Two metal zip ties are included. Only one is required for installation; the second is provided as a spare. + +#### Installation Instructions + + 1. Prepare the Spike Holders: Insert a metal zip tie through each spike holder, ensuring that the holes are facing upward. + 2. Insert the Spikes: Place a metal spike into each hole on the spike holder. + + + + 3. Attach the Spike Holders to the Rain Cup: Wrap the zip tie around the rim of the rain cup and tighten it securely to prevent the spike holders from loosening or falling off. For easier installation, + it is recommended to first remove the rain cup by twisting it lightly before attaching the spike holders. + + + + 4. Secure the Metal Zip Tie: Carefully secure the metal zip tie on top of the rain cup to ensure the spike holders are firmly in place and will not fall off. + + + + 5. Place the spikes, short side down, in the designated spots on the ring. The final setup should match the image below. + + + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). + +--- +# Connect and Claim the Gateway +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/connect-and-claim +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/connect-and-claim.md + +## WG3000 Gateway + +The weather station comes together with the WG3000 Gateway. +The WG3000 Gateway receives all the meteorological data plus the location of the weather station, and forwards it to the WeatherXM network via cellular networks. +In this chapter, you will find guidance to set up the WG3000 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. The [WeatherXM](/wxm-devices/pulse/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +
+ +## Step by Step Instructions + +### Connect WG3000 Gateway to power source and turn the gateway on + +The WG3000 Gateway must be placed on a sunny surface, facing south, and with no obstacles in front of it. + +
+ +### Change Frequency (Optional) + + + +The WG3000 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 3 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz +- Model C: 923 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency +1. Navigate to the "Device Settings" menu by pressing the arrow keys on your WG3000 Gateway. + + + +2. Click the Frequency options and select the new frequency your WG3000 Gateway will listen to. + + + +3. Select the new frequency by pressing the "OK" button. + + + + +4. The Gateway will now reboot to accept the new frequency. + +:::caution +If you don't use the correct frequency as your weather station, WG3000 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Prepare for claiming your WG3000 Gateway + + + + + #### Find the barcode on the WG3000 Gateway + + You can find the barcode on the back of the WG3000 Gateway. You will need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + +:::tip +In case you have trouble scanning the barcode, you can manually type the serial number and claiming key. +::: + +
+### Enter your Claiming key + + + + + #### Navigate to W3000 Gateway and reveal the claiming key + + Navigate to "Device Settings" menu by pressing the arrow keys on your WG3000 Gateway right on the screen and select the "Claim Device" option, a QR code will appear. + + You'll need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + +:::tip +The claiming key is a 6 digits code that is used to claim your station. The device remains on claiming mode for 10 minutes. If you don't claim it in this time frame, you will need to repeat the process. +::: + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: + +--- +# Box Contents of Pulse bundle (WB3000) +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/contents +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/contents.md + +## Included + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Bracket (for WG3000 Gateway)
    5. +
  5. Bracket (for pole mounting)
    6. +
  6. Jubilee clips (x2)
    7. +
  7. Screws for securing the bracket to WG3000 Gateway (x3)
    8. +
  8. Screws and fischer wall plugs (x2)
    9. +
  9. WG3000 Gateway
    10. +
  10. Power supply cable (USB-C)
    11. +
  11. External Battery Pack
    12. +
  12. Zip ties
    13. +
  13. Bird Spikes
    14. +
+ + +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 20 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1001 Weather Station](/wxm-devices/pulse/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG3000 Gateway + + + +The WG3000 Gateway is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via cellular connection to the WeatherXM network. + +The WG3000 Gateway is advised to be placed outdoors, ideally on a the same pole as the Weather Station, to ensure the best possible connection to the cellular network and with the Weather Station. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. + +--- +# Installing WS1001 Weather station +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/install-weather-station +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/install-weather-station.md + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. + +--- +# Introduction of Pulse bundle (WB3000) +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/introduction +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/introduction.md + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG3000 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG3000 Gateway + +- Cellular (2G/3G/LTE) + GPS + LoRa +- Hardware encryption +- Forwards weather data via Cellular networks (Integrated SIM card) +- Powered by integrated battery and solar panel (ext. power supplies supported) +- Over-the-air firmware upgradable +- Reporting Interval: 20min + +### WS1001 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG3000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG3000 Gateway is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + +Powered via a small solar panel and batteries and communicates with the WG3000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG3000 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + + +--- +# Maintenance of Pulse bundle (WB3000) +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/maintenance +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/maintenance.md + +## WS1001 Weather Station + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG3000 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/d1/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: + +
+ +## WG3000 Gateway + +WG3000 Gateway only requires minimal maintenance, which includes the cleaning of the solar panel and the visual inspection of the device. + +--- +# Troubleshooting of Pulse Bundle (WB3000) +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/troubleshooting +Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/troubleshooting.md + +## Weather Station + +### Data Gaps + +If the error message "Data gaps" is displayed on the mobile app, the WG300 Gateway is not receiving RF signals. +This can be due to a variety of reasons. + +First make sure you WG3000 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/pulse/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/pulse/assemble)) for flashing. +The LED should flash every 20 seconds. + +If the LED is not flashing every 20 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors. +Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG3000 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. + +2. Try to place the WG3000 Gateway at the desirable point and check that it receives data. + +3. If you still have intermittent problems, move the weather station and the WG3000 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG3000 Gateway. + Relocate the weather station and WG3000 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. + +:::note +It is recommended to place the WG3000 Gateway on the same pole as the weather station. +::: + +
+ +### Station Battery Level is Low + +If your Mobile App reports "Station Battery Level is Low" on the screen, the weather station will run out of battery soon. + +Replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by reading [Best Practices for Proper Station Installation](/wxm-devices/pulse/install-weather-station#best-practices-for-proper-station-installation). + +
+ +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/pulse/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +
+ +### One or more variables are extremely high, low, or constant for long periods of time. + +If you notice that some variables are extreme or constant it is possible you need to replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Reported pressure appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +
+ +## GPS Location + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## Other Issues + +### My WG3000 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### Why is my station showing offline? + +Assuming that the WG3000 Gateway unit is placed outdoors facing south, this may be due to a bad RF connection between that Gateway and the outdoor station. +Please make sure that the WG3000 Gateway is placed outdoors, ideally on the same pole as the Weather Station, to ensure the best possible connection to the cellular network and with the Weather Station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: diff --git a/static/llms-pages/faq.md b/static/llms-pages/faq.md new file mode 100644 index 00000000..d74f4384 --- /dev/null +++ b/static/llms-pages/faq.md @@ -0,0 +1,148 @@ +# Help Center / FAQ + +Canonical: https://docs.weatherxm.com/faq + +:::tip +Remember that you always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. +::: + +## Data + +### Is there a chance for my host/friend to be able to have access to my station's data? + +Yes! It was a common feature request so we have implemented it. You can share your station's data with your friends by using the share button on the station's page on the [explorer](https://explorer.weatherxm.com/). Also, you can "favourite" any station you like by clicking on the heart shaped button while using our mobile App. +The station will appear in your station list. + +
+ +### How do you know people are not faking the location of their station on the map? + +In addition to the cryptographic proofs from all station data sent to the WeatherXM Network, we have designed and implemented a unique Proof of Location algorithm to safeguard the accuracy of the weather station location. Read more at the [PoL section of the documentation](/rewards/proof-of-location). + +## Hardware + +### Can I connect my WXM station with a 3rd party station? + +Our weather stations are custom built, they are developed to connect to our network with our firmware and software implementations. The SDR receiver is no longer on our roadmap. + +
+ +### What are the differences between the WG1000 gateway station and the WXM Helium compatible station? + +1. The WeatherXM Helium station has an integrated (located within the weather station) Helium-compatible LoRaWAN chip, crypto chip, and GPS while the Wi-Fi bundle has a Wi-Fi gateway, crypto chip, and GPS located within the external WG1000 gateway. +1. WeatherXM Helium station can only connect to the Helium Network while the Wi-Fi bundle can only connect to Wi-Fi. +1. The WeatherXM helium weather station has a larger solar panel which allows it to do processing standalone (in the station itself) while the Wi-Fi bundle's station has a smaller solar panel since the processing is done by the external WG1000 display and Wi-Fi gateway (located indoors) which the station communicates to over RF. +1. The WeatherXM Helium bundle does not contain any type of display to view weather data. Weather data will have to be viewed from the WeatherXM app. + +
+ +### Can I connect my WeatherXM Helium compatible station to any Helium around or should I request access from someone? + +You can connect your WeatherXM Helium compatible station anywhere with Helium network coverage or near a Helium gateway. The gateway that will handle your packet is usually the fastest to respond but this is influenced by numerous factors. This means that the closest Helium gateway will not necessarily be the one that will pick up your packet, nor you can choose or influence this. + +
+ +### Will it make a big difference if I place my station on the balcony instead of the roof? + +It is mandatory that you place your station on the roof and the reason is because there aren't so many obstacles as there are on a balcony (e.g walls), that will reduce the quality of your data, therefore the amount of your rewards. +You can also check the [deployment examples](/wxm-devices/deployment-examples) for inspiration. + +
+ +### Is any of your stations suitable for very cold climates? + +For very cold climates that have snow most of the year, we will be launching soon a special weather station with a heater suitable for these weather conditions. + +
+ +### Which is the recommended frequency for my country? + +You can refer to the mapping table that provides detailed information on the frequency allocations per country by visiting the [frequencies plans](/wxm-devices/frequency-plans) page. + +## Rewards + +### How can I start receiving rewards? + +If you have already set up your station and claimed your device via the app, please add Metamask and follow the instructions [here](/mobile-app/wallet/add-edit-wallet-address) and then follow this guide to [claim your rewards](/rewards/rewards-claiming). + +
+ +### How can I check my rewards? + +You can check your rewards by using our mobile App and follow this guide to [claim your rewards](/rewards/rewards-claiming). + +
+ +### Do I have to pay for the HNT/DC fees? + +We are covering the HNT/DC fees. + +
+ +### Can I change my wallet address in the future? + +You can change your wallet address in the future. Just so you know, rewards are allocated daily per your wallet, if you change wallet in the future then the rewards up to that moment are allocated to your previous wallet. +Unclaimed rewards cannot be transferred to a new wallet and can only be claimed by the connected wallet address at the time of rewards allocation. + +
+ +### How many stations are allowed in a Hex? + +Such details will be defined in by the [WeatherXM Network](https://weatherxm.network/). + +
+ +## Sales + +### Can I receive my invoice before my order ships? + +You will receive your invoice and receipt when your order ships. If you need an invoice earlier you can contact us through [support](https://support.weatherxm.com). + +
+ +### When will my order ship? + +We are improving our logistic methods and you will receive your order in 1-2 weeks. + +
+ +### Can I change my shipping address? + +As long as your order hasn't shipped you can contact us through [support](https://support.weatherxm.com) and we will change it for you. + +
+ +### Can I request a refund? + +You can request a refund by sending us a message through [support](https://support.weatherxm.com) and we will refund you according to our [refund policy](https://weatherxm.com/terms-conditions/). + +
+ +### Can I cancel my order if it has already been shipped? + +You can not cancel it if it has already been shipped but you can deny the delivery when it reaches to your door and we will refund you according to our [refund policy](https://weatherxm.com/terms-conditions/). + +
+ +### Where do you ship the devices from? + +We ship from China and then the devices are distributed to our warehouses in US/CA/UK/EU. + +
+ +### How can I purchase more than 2 weather stations? + +You can complete our [bulk sales](https://pages.weatherxm.com/bulk-order-form) form and we will contact you as soon as possible. + +
+ +### How much time does it take for the refund to reflect to my bank account? + +Note that refunds take 3-15 working days to reflect on your bank account. +If it hasn't been reflected in your bank account after 15 days you should contact us by sending a message through [support](https://support.weatherxm.com) + +
+ +:::tip +Remember that you always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. +::: diff --git a/static/llms-pages/glossary.md b/static/llms-pages/glossary.md new file mode 100644 index 00000000..a1cdefaa --- /dev/null +++ b/static/llms-pages/glossary.md @@ -0,0 +1,17 @@ +# Glossary of Common Terms + +Canonical: https://docs.weatherxm.com/glossary + +| Term | Description | +| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Barometer | A barometer is a device that measures the pressure of the air pushing on it—this measurement is called the barometric pressure. We don’t actually feel the barometric pressure because the air pressure is pushing equally in every direction. | +| HectoPascals (hPa) | This is an international standard (SI system) for measuring air pressure. It used to be referred to as milli-bar (mb) and sometimes still is. They are equivalent. | +| Hygrometer | The instrument that measures the relative humidity of the air. This is expressed as a percentage between 0% and 100%. | +| Millimetres (mm) | This is the unit in which the rain amount is measured. 1 mm corresponds to 1kg/m² of water. | +| Rain Rate | Rain rate is a measurement of the intensity of rainfall. It gives the amount of rain that would fall over a time period if the rain rate was constant over that time period. It is usually measured in millimetres per hour (mm/h). | +| Relative Air Pressure | Relative air pressure is the absolute air pressure compensated for the altitude of the barometer. The result is what the air pressure would be at sea level. This measurement appears on the WXM-M5 screen. | | +| Relative Humidity (RH) | It is a measure of the water vapour content of air. In particular, RH is the percentage (%RH) of water vapour that is present in a sample of air to the amount needed to achieve saturation at the same temperature. | +| Ultra Violet (UV) Index | The ultraviolet index or UV-Index (UVI) is an international standard measurement of the strength of sunburn-producing ultraviolet (UV) radiation at a particular place and time. The purpose of the UV Index is to help people effectively protect themselves from UV radiation. The UV Index is a linear scale, with higher values representing a greater risk of sunburn (which is correlated with other health risks) due to UV exposure. An index of 0 corresponds to zero UV radiation, as is essentially the case at night. An index of 10 corresponds roughly to midday summer sunlight with a clear sky when the UV Index was originally designed, but values above 10 are sometimes possible. Levels above 8 are considered “very high” and above 11 are considered “extreme.” | +| Wind Direction | Wind direction is defined as the direction the wind is coming from. | +| Wind Speed | Wind speed is the speed of the weather-related air movement from one place to the next. | +| Wind Gust | Highest measured wind speed over a 10 minute period. | diff --git a/static/llms-pages/index.md b/static/llms-pages/index.md new file mode 100644 index 00000000..b12f05cd --- /dev/null +++ b/static/llms-pages/index.md @@ -0,0 +1,74 @@ +# Homepage + +Canonical: https://docs.weatherxm.com/ + +## Welcome aboard + +WeatherXM is a community-powered weather network that rewards weather station owners and provides accurate weather services to Web3 enterprises. +WeatherXM weather stations are the world’s first to natively support Web3 technologies. + +
+ + + + +

WeatherXM M5 bundle (WB1000)

+ This is our developer friendly, local weather data miner bundled with an easy to set up all-in-one weather station. + + + + + + + +

WeatherXM Helium station (WS2000)

+ Compatible all-in-one weather station. Connects to Helium network and submits weather data to WeatherXM. + + + +
+ +
+ + + + +

WeatherXM D1 bundle (WB1200)

+ The WB1200 is a bundle product that combines the WS1001 weather station with our open source WeatherXM WG1200 Gateway. + + + + + + + +

WeatherXM Pulse bundle (WB3000)

+ The WB3000 is a bundle product, that combines the WS1001 weather station with our WG3000 Gateway which uses 4G - LTE. + + + +
+ +

WeatherXM Project

+ +WeatherXM creates an entirely new weather data economy that rewards people who deploy and maintain weather stations. + +They are all-in-one, easy to deploy, energy and communication autonomous, and designed for large-scale deployment. +WeatherXM makes weather-related smart contracts on-chain a reality. + +This documentation site attempts to explain various aspects of the WeatherXM project. + +

Thank you for supporting WeatherXM!

+
Quick Links
+ +• The $WXM Token +

+• WeatherXM Pro +

+• Reward Mechanism +

+• Data Quality +

+• Proof of Location (PoL) +



+Join our Discord Community Server. diff --git a/static/llms-pages/introduction.md b/static/llms-pages/introduction.md new file mode 100644 index 00000000..446c6cb7 --- /dev/null +++ b/static/llms-pages/introduction.md @@ -0,0 +1,68 @@ +# Introduction + +Canonical: https://docs.weatherxm.com/introduction + +

+

+ WeatherXM creates an entirely new weather data economy that rewards people + who deploy and maintain weather stations. +

+ + + + +## Introduction + +**_Enter Weather 3.0_** + +**WeatherXM** is a unique weather network that relies on the power of the community to deploy and maintain weather stations. +By doing so, participants not only contribute to the network's growth but also get rewarded with the WXM token. +The network is EVM compatible and is deployed on [Arbitrum One](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6). + +WeatherXM has a vision to become the largest, most decentralised, and most distributed weather network in the world. +You can stay updated on the current state of the network by checking out our [explorer](https://explorer.weatherxm.com). + +Some significant milestones we have achieved so far: + +### Reward Mechanism + +Current [Reward Mechanism v2.0](/rewards/reward-mechanism) includes significant improvements over previous versions. +Business Boost rewards have been added, with predefined criteria for fairness. +A Merkle Tree structure has been implemented for transparent reward distribution. +Users can withdraw their rewards whenever they choose to do so. +The Merkle Tree structure facilitates a verifiable and transparent mechanism for users to validate reward distribution. +These improvements aim to refine the Reward Mechanism, making it more inclusive, nuanced, and transparent to build trust among weather station owners participating in the network. +More on [Reward Mechanism](/rewards/reward-mechanism). + +### Weather stations + +WeatherXM weather stations are not generic sensors. They are purpose-built devices designed to operate as trusted, upgradeable data sources in a decentralised network. + +All stations run custom WeatherXM firmware that is remotely updateable (FOTA updates). This allows continuous improvement of measurement techniques, calibration logic, and data processing without hardware replacement. The same update mechanism is also used to add new features over time, keeping deployed stations up to date and allowing improvements to be rolled out across the entire network in controlled way. + +Every data point produced by a station is cryptographically signed at the source. Stations sample environmental data every 16–20 seconds (depending on the model), then aggregate these high-frequency readings inside the device into 1–3 minute data packets (depending on the configured mode) before signing and transmission. This signature proves that the data originated from a specific physical station and that it has not been altered in transit or storage. As a result, users can verify authenticity rather than rely on trust assumptions. + +Each station also includes a GPS receiver. The reported location is cryptographically signed and can be verified ensuring that both the measurements and their geographic location originate from the device. This prevents location spoofing and enforces the integrity of hyperlocal weather data across the network. + +Together, remote upgradable firmware, on device cryptographic signing, and GPS backed location verification form the technical foundation that differentiates WeatherXM stations and enables a verifiable, high quality weather data economy. + +### Data Quality + +[Data Quality](/rewards/data-quality) is an algorithm that assesses the quality of weather data provided by a weather station. The score it generates shows how confident we can be in the quality of the data received. Our goal is to make sure that the data we receive is meaningful and usable, and the Data Quality score helps us measure this metric. Ultimately, we want to encourage weather station owners to follow our guidelines so that they can consistently achieve the best possible Data Quality score. + +To achieve this, Data Quality Algorithm relies on a range of techniques and processes designed to help us differentiate between expected and unexpected data behaviors. +More on [Data Quality](/rewards/data-quality). + +### WeatherXM Pro + +[WeatherXM Pro](/weatherxm-pro) is our premium service that provides enhanced access to hyperlocal weather data, advanced analytics, +and integration-ready tools — designed for professionals, developers, and businesses that rely on accurate, location-specific forecasts and hyperlocal data. + +### WeatherXM Devices + +Currently we use 4 main types of devices: + +- [WeatherXM M5 Bundle (WB1000)](/wxm-devices/m5/introduction) which is the WiFi version +- [WeatherXM Helium Version (WS2000) ](/wxm-devices/helium/introduction) which is the Helium version +- [WeatherXM D1 bundle (WB1200)](/wxm-devices/d1/introduction) which is the upgraded WiFi version +- [WeatherXM Pulse bundle (WB3000)](/wxm-devices/pulse/introduction) which is the 4G/LTE version diff --git a/static/llms-pages/mobile-app/change-password.md b/static/llms-pages/mobile-app/change-password.md new file mode 100644 index 00000000..e020a6e2 --- /dev/null +++ b/static/llms-pages/mobile-app/change-password.md @@ -0,0 +1,28 @@ +# How to change password to your account + +Canonical: https://docs.weatherxm.com/mobile-app/change-password + +In order to change your account's password you need to use our mobile app. There are different methods of resetting your password whether you are logged in or out. + +:::caution +The confirmation email to change your account password normally arrives within some minutes. + +If you haven't received the email, contact our support team at [Support](https://support.weatherxm.com/hc/en-us) + +Please, do not forget to also check your **spam** folder. +::: + +### Logged in +- Go to My profile, then choose "Preferences & Settings" and press "Change Password" button, enter your account's email. You will receive an email with a link to change your password. + + + +### Logged out + +- Open the App and the login page must appear, press "Forgot password" button, enter your account's email. You will receive an email with a link to change your password. + + + +:::note +- **The instructions above are for both versions of the App (Android and iOS).** +::: diff --git a/static/llms-pages/mobile-app/delete-account.md b/static/llms-pages/mobile-app/delete-account.md new file mode 100644 index 00000000..c60a3c64 --- /dev/null +++ b/static/llms-pages/mobile-app/delete-account.md @@ -0,0 +1,28 @@ +# Delete WXM Account + +Canonical: https://docs.weatherxm.com/mobile-app/delete-account + +:::caution +By deleting your account, you will **no longer be eligible to gain WXM rewards**, and you will **no longer be able to view your station data** in the WeatherXM apps. + +This **will delete** the following data: + - Your name. + - Your email address. + - Your station(s) details, their location, and their token rewards history. + +This **will not delete**: + - The weather data you’ve shared with the network. + - The WXM rewards you’ve collected. These are yours forever! + +#### We do not collect nor store any other personal data! + +If you have any questions regarding your data and the deletion of your account, please contact our [support team](https://support.weatherxm.com) +::: + +
+ + + +Go to the settings screen and press "Delete Account" button, read carefully the instructions. **This procedure is irreversible** + +
diff --git a/static/llms-pages/mobile-app/wallet/add-edit-wallet-address.md b/static/llms-pages/mobile-app/wallet/add-edit-wallet-address.md new file mode 100644 index 00000000..9f57e3f0 --- /dev/null +++ b/static/llms-pages/mobile-app/wallet/add-edit-wallet-address.md @@ -0,0 +1,62 @@ +# Add/edit wallet address + +Canonical: https://docs.weatherxm.com/mobile-app/wallet/add-edit-wallet-address + +:::tip +If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +::: + +## Add wallet address for the first time + +To add your wallet address, go to settings screen and tap "My wallet", then fill or scan your wallet address where you can find at your metamask account, read and accept the terms and services and acknowledge that you have ownership and full access to this wallet. + + + + + +
+ +## Edit your wallet address + +To edit or change your wallet address, go to settings screen and tap "My wallet" and tap on "Edit Wallet Address". In order to edit the Wallet Address you need to confirm you are the owner of this account. + + + + + +
+ +## How to create wallet on Metamask + +\$WXM is deployed on Arbitrum One Network. We suggest you use a **MetaMask** wallet with WeatherXM, as we have extensively tested on it. As we evolve, we will official support several wallets. +By following our guide, it's fairly simple to set up a MetaMask wallet and add a custom token (in our case, the \$WXM token) on Arbitrum One Network. + +:::note +The following guide has been written with the **MetaMask browser extension** in mind. +The steps may vary on other platforms like the mobile app. +::: + +## Installing and setting up MetaMask + +MetaMask is a crypto wallet app and browser extension. + +:::caution +Only install this wallet from the [official MetaMask website](https://metamask.io/download/)! +::: + +1. MetaMask is available to download and install on Chrome, iOS, and Android through the [MetaMask website](https://metamask.io/download/). +Always check if you are using the official website to make sure you’re installing the real MetaMask extension. +1. After installing the extension, you’ll be greeted with the MetaMask welcome page. Click [Get Started] to begin. +1. If you’re creating a new wallet, click the [Create a Wallet] button. You can also import an existing wallet using its seed phrase with the [Import wallet] option. +1. MetaMask will ask you if you’d like to share anonymous usage data with them to help improve the extension. Accepting or refusing this will not affect your MetaMask usage. +1. Choose a secure password to log in to your wallet from your browser. Note that this is not your seed phrase. The password is a security measure to prevent anyone using your device from accessing your wallet. + If you forget your password, you can always access your crypto with your seed phrase. +1. After choosing your password, MetaMask will present you with information regarding your wallet’s seed phrase. Make sure to read through it if you aren’t familiar with how a crypto wallet works. +1. You’ll now be presented with your seed phrase. Click the lock to view the words and take note of them in the correct order. Keep the phrase in a secure place (preferably offline) and never share it with anyone. + This string of words is the final backup of your wallet and its contents. Click [Next] to continue. +1. You’ll now have to repeat your seed phrase by selecting the words at the bottom of the screen in the right order. Click [Confirm] once this is complete. +1. Your MetaMask wallet will now be set up and ready to use. Click [All Done] to view your wallet. + +:::note +If you want to confirm the existence of your tokens in your preferred wallet, you need to add our ERC20 token's smart contract. See how [here](/rewards/how-to-join-arbitrum-and-see-your-tokens#add-wxm-token-in-metamask) +::: diff --git a/static/llms-pages/rewards/cell-capacity.md b/static/llms-pages/rewards/cell-capacity.md new file mode 100644 index 00000000..394b419b --- /dev/null +++ b/static/llms-pages/rewards/cell-capacity.md @@ -0,0 +1,30 @@ +# Cell Capacity (CC) + +Canonical: https://docs.weatherxm.com/rewards/cell-capacity + +**Cell Capacity (CC)** is a parameter that is used to define the maximum number of stations that may receive rewards in a specific cell. + +Each cell has a predetermined capacity that depends on its unique geospatial features. The capacity of a cell is the maximum number of weather stations that are eligible for rewards in that particular cell. +If there are 'N' rewardable weather stations in a cell with a capacity of 'CC' on a given day, and if N exceeds CC, then only the first N stations +(ordered first by their reward score, defined in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section, and then by seniority) will receive rewards. + +:::tip +Cell capacity is a parameter that is used to define the maximum number of stations that are eligible for rewards in a specific cell. Every cell has a predefined capacity that depends on its geospatial characteristics*. +::: + +### Last Claim Time (LCT): +Claim time is a unix timestamp (integer). +Last Claim Time is set to the timestamp of the last claim of the station. It is used as a **seniority indicator** ( LCT1{'<'}LCT2 then station 1 is more senior than station 2). + +### Cell Ranking: +Cell ranking is a way to measure how well a station performs compared to others within the same area, which is about 5 square kilometres (2 square miles) on the planet. Each station is ranked every day based on their reward score and seniority. +If a station's ranking is above the capacity threshold, it will be rewarded. +However, if the ranking falls below the threshold, the station won't receive any rewards. For instance, in a cell with a maximum capacity of 5 stations, a station that is ranked 3rd would be rewarded, but a station ranked 7th would not receive any rewards. + +## Related articles +- [We are opening the WeatherXM cell modelling to the world (WeatherXM Blog)](https://blog.weatherxm.com/we-are-opening-the-weatherxm-cell-modelling-to-the-world-b827f1c10c2d) +- [Defining the density of a multi purpose global weather network (WeatherXM Blog)](https://blog.weatherxm.com/defining-the-density-of-a-multi-purpose-global-weather-network-ea5f4190f91a) + +:::note +The cell capacity is currently set to the fixed value of 10 rewardable stations, for every cell. +::: diff --git a/static/llms-pages/rewards/data-quality.md b/static/llms-pages/rewards/data-quality.md new file mode 100644 index 00000000..a6e52fba --- /dev/null +++ b/static/llms-pages/rewards/data-quality.md @@ -0,0 +1,125 @@ +# Data Quality + +Canonical: https://docs.weatherxm.com/rewards/data-quality + +:::info +Data Quality algorithm is currently on version 1.0. This page serves as both an informational resource about its current status and a glimpse into its future. +::: + +**Data Quality** is an algorithm that evaluates the quality of weather data provided by a weather station. +The calculated score indicates the confidence level in the quality of the weather data received from a station. +We need meaningful and usable data and the Data Quality score is an attempt to quantify this metric. +The end goal is to encourage weather station owners to do their best to comply with the Network's guidelines in order to consistently +achieve the best Data Quality score possible. + +>![QoD current state](image) + +It’s the method we use to assess the quality of each data point we receive from WeatherXM stations. +Data Quality algorithm involves a series of techniques and processes designed to help us distinguish between expected and unexpected data behaviors. + +This mechanism includes the following 3 control points and their respective checks: +1. Self Check + * Out-of-Bounds Check (OBC) (Data Quality v1.0) + * Self Quality Check (SQC) (Data Quality v1.0) +2. Reference Check + * Comparative Quality Control (CQC) (Data Quality v1.3) +3. Deployment status + * Indoor Station Detector (ISD) (Data Quality v1.1) + * Solar Obstacle Detector (SOD) (Data Quality v1.2) + * Wind Obstacle Detector (WOD) (TBD) + +The Data Quality algorithm is designed to be a daily process, with the exception of the Deployment Status. + +## 1. Self Check +Self-check is the basic component of the Data Quality algorithm, designed to identify common faults within datasets using only the data from the weather station being investigated. Self-check should run once per day. The following steps are included: + +### a. Out-of-Bounds Check (OBC) +OBC is a simple process that involves identifying values that fall outside the specifications set by the manufacturer for each sensor. +As an example, if the temperature sensor is able to measure within a temperature range of -60 to 60°C, then the value 80°C is considered as faulty. + +### b. Self Quality Check (SQC) +SQC is the process that identifies unexpected behaviour in the measured parameters, which could be attributed to a defective sensor or an improper station deployment. +It should be noted that OBC is included in SQC as the first step of this process. +The final result of this process is the annotation of the data in 3 levels: + +- Raw (16’’ or else depending on weather station’s specs) +- Minute (1’ or 2’ depending on the parameter) +- Hourly (aiming to reward each of 24 slots of a day) + +The following processes take place (excluding OBC): + +- Re-framing the timescale of raw data at a fixed time interval (as raw data may not always be measured at a constant time-step) +- Looking for time-slots with no data +- Looking for constant data over a certain period (e.g., constant temperature over an hour, or constant wind speed/direction over an hour under freezing -or not- conditions) +- Looking for unexpected jumps of consecutive raw data or averaged values of consecutive minutes +- Calculating the percentage of valid data within a certain period (minute, hour) + +The final result is text/numerical annotations and percentage of valid data over each time-slot in raw/minute/hourly level. Validity for meteorological purposes may differ compared to validity for reward purposes. Thus, there is a final annotation of each hour slot for meteorological and reward purposes. + +## 2. Reference Check +This part of Data Quality algorithm focuses on comparing the data of a weather station with: + +a. Another neighbouring reliable weather station of the WXM network

+b. Another neighbouring reliable 3rd party weather station

+c. 3rd party post-processed modelled weather data (a process similar to data assimilation) + +The Reference Check may be able to detect abnormal behaviour of the parameters measured by a station. +Such a control could give insight in the quality of both data and deployment +(e.g., temperature diurnal cycle of a station agrees with a reference timeseries, temperature of a station is usually higher because it is close to a chimney etc). + +### Comparative Quality Control (CQC) +In order to apply this control we deploy the Comparative Quality Control (CQC), +which falls into an internal and external version depending on the type of data used for the analysis +(internal -using data owned by WXM- and external -using 3rd party data-). +Reference Check should run once per day together with Self Check. + +## 3. Deployment Status +The Deployment Status control can be used as an identifier of the obstacles around a weather station. As solar irradiance and wind are parameters that are fairly sensitive to obstacle interventions, two different processes have been designed to determine the quality of deployment: + +a. Indoor Station Detector (ISD)

+b. Solar Obstacle Detector (SOD)

+c. Wind Obstacle Detector (WOD) + +Both processes require a long timeseries typically of a few weeks to a few months, thus they should run once per a few months or a year. +This means that the Deployment Status part of Data Quality algorithm can only be used to characterise the deployment of a weather station. + +### a. Indoors Station Detector (ISD) +The purpose of this mechanism is to identify all the stations located in a house or a box. +This process requires solar irradiance, latitude, longitude and day of the year. + +### b. Solar Obstacle Detector (SOD) +This process examines the solar irradiance parameter comparing it with the theoretical solar irradiance expected for a given location and day of the year. Note that the theoretical solar irradiance is the total amount of solar irradiance that arrives at a horizontal surface on the Earth under clear sky conditions. +Because of that, a long period of data is required for detecting a totally clear-sky day. This method: + +- Detects a clear sky day +- Compares theoretical and observed solar irradiance on a clear-sky day +- Compares observed solar irradiance within a short period (e.g., a 5-day window), in order to find similarities (i.e., systematically decreased solar irradiance at a certain period of day) + +The limitations of this method are that: +- Only south horizon of a station can be examined for obstacles +- The solar angle is different from a season to another, thus different obstacles may be visible at different period of the year + +Despite of such limitations, it is still a useful method for detecting obstacles that may affect solar irradiance, but also the other parameters. + +### c. Wind Obstacle Detector (WOD) +As wind is the most demanding (in terms of fulfilling the WMO deployment criteria) parameter, this method should be able to identify any significant obstacles around a weather station. + +The basic idea is that we collect measurements of significant wind (e.g., >5m/s) of all the 16 direction of wind and then we compare them with wind measurements of a reference station or post processed modelled data. Then, the directions at which wind speed is significantly underestimated are suspicious for obstacles. + +This mechanism can be used to characterise the general deployment of a weather station, but can also identify the directions that wind measurements may not be reliable. + +## Data Quality Threshold +Data_Quality_Threshold is a rational number in the range [0,1]. +This number indicates the minimum Data Quality score a station must have on a given day in order to be eligible for rewards. + +## Data Quality Components Outcome +>![The Data Quality Components](image) + +:::note +Data Quality score is a rational number in the range [0,1] +::: + +## References +- [WeatherXM Network](https://weatherxm.network/) +- [Data Quality Simplified - Medium article](https://medium.com/weatherxm/weatherxm-qod-quality-of-data-simplified-b5a42aee7367) +- [Technical description of the process for Data Quality v1.0](https://docs.google.com/document/d/e/2PACX-1vR5UTaVXtmoXnbnpukE5ocFOcYjZAiuFH4mZU6Wgkj0OP7sAVYh5ep3PgMxyJe61uqaq9TAdHPbi-TU/pub) diff --git a/static/llms-pages/rewards/hardware-class.md b/static/llms-pages/rewards/hardware-class.md new file mode 100644 index 00000000..ac3924e4 --- /dev/null +++ b/static/llms-pages/rewards/hardware-class.md @@ -0,0 +1,13 @@ +# Hardware Class + +Canonical: https://docs.weatherxm.com/rewards/hardware-class + +Hardware-Class Weight (HCW): HCW is a rational number > 0. + +Each type of approved hardware (weather station) belongs to a specific Hardware Class. +Hardware Classes are used to award more tokens to weather stations that have special capabilities, +increased sensor accuracy or range, new sensor types, or other capabilities that make them more valuable to the network. + +:::note +For the time being all Hardware Classes are considered equal. +::: diff --git a/static/llms-pages/rewards/how-to-join-arbitrum-and-see-your-tokens.md b/static/llms-pages/rewards/how-to-join-arbitrum-and-see-your-tokens.md new file mode 100644 index 00000000..bb01e8e2 --- /dev/null +++ b/static/llms-pages/rewards/how-to-join-arbitrum-and-see-your-tokens.md @@ -0,0 +1,55 @@ +# How to join Arbitrum and see your tokens + +Canonical: https://docs.weatherxm.com/rewards/how-to-join-arbitrum-and-see-your-tokens + +:::tip +If you don’t have a wallet, [create one](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +::: + +## Add Arbitrum One Network to Metamask + +Adding Arbitrum One Network support to MetaMask is a mandatory step in order to add the WXM token, view activity, and make transactions. +Make sure you follow our step-by-step guide below for adding the Arbitrum One Network to MetaMask. + +You can add Arbitrum One Network to MetaMask by following the instructions below: + +### Using Arbiscan + +:::note +Please make sure you have already installed **[MetaMask](https://metamask.io/)**! + +**This solution works only on desktop with the MetaMask browser extension already installed.** +::: + +Please follow the steps to add Arbitrum One Mainnet: + +- Navigate to [Arbiscan.io](https://arbiscan.io/) +- Scroll down to the bottom of the page and click on the button `Add Arbitrum One Network` + ![Arbitrum One](image) + +- Once you click the button you will see a MetaMask notification, now click on **Approve**. +You will be directed to Arbitrum's Mainnet in the network dropdown list. You can now close the dialog. + + +
+ +## Add WXM token in MetaMask + +For the WXM token to appear in the wallet UI, you will need to add it manually. +Note that your wallet can still receive tokens that haven’t been imported. + +:::note IMPORTANT NOTE +Please make sure you have already added the **Arbitrum One** and have connected to it by following the guide above! +::: + +1. First, you will need the following details of the WXM token in order to add it: + 1. **Token Contract Address:** ``0xB6093B61544572Ab42A0E43AF08aBaFD41bf25A6`` + 1. **Token Symbol:** ``WXM`` + 1. **Token Decimal:** ``18`` + + You can verify those details on [Arbiscan](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6). +1. On MetaMask and click **[Import tokens]**. +1. Paste in the WXM’s contract address and MetaMask should automatically fill in the rest of the details. If not, add them manually. To finish, click **[Add Custom Token]**. +1. Click **[Import Tokens]**. + +**You have now successfully added the WXM token to your MetaMask wallet!** diff --git a/static/llms-pages/rewards/proof-of-location.md b/static/llms-pages/rewards/proof-of-location.md new file mode 100644 index 00000000..e341439a --- /dev/null +++ b/static/llms-pages/rewards/proof-of-location.md @@ -0,0 +1,28 @@ +# Proof of Location (PoL) + +Canonical: https://docs.weatherxm.com/rewards/proof-of-location + +The **Proof-of-Location** algorithm evaluates location data associated with the station, their accuracy, and consistency. It generates a score which is a confidence indicator about the station’s location. WeatherXM places great importance on station continuity, and discourage relocations. + +## Proof-of-Location (PoL) +PoL is a rational number in the range [0,1]. +A station’s PoL must be greater than or equal to PoL_Threshold to be considered for inclusion in WeatherXM's **Rewarding Mechanism**. +PoL is a dynamic value, and is recalculated every time a station’s location is updated. + +### Calculation: +Currently, PoL is calculated daily using Location Packets. +- For M5, D1 and Pulse, at least one accurate Location Packet from the previous day is required to determine the Location. +- For H1 stations, at least one accurate Location Packet from the previous day is required to determine the Location, if no Location Packets are available, the PoL algorithm will rely on data from the day before. + +## Relocation +It is important for the Network that a station remains at the same location throughout its lifetime. +When a weather station undergoes relocation, its Proof of Location score reduces to 0 for 7 days and its seniority is reset. +After 7 days, the station’s PoL is recalculated, and if it is greater than or equal to PoL_Threshold, the station is considered for inclusion in the [WeatherXM Network](https://weatherxm.network/). + +:::info +Proof of Location penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: + +:::note +PoL is a rational number in the range [0,1] +::: diff --git a/static/llms-pages/rewards/reward-boosts.md b/static/llms-pages/rewards/reward-boosts.md new file mode 100644 index 00000000..1c1953e9 --- /dev/null +++ b/static/llms-pages/rewards/reward-boosts.md @@ -0,0 +1,101 @@ +# Reward Boosts + +Canonical: https://docs.weatherxm.com/rewards/reward-boosts + +## Overview + +**Reward boosts** are additional rewards given to stations that contribute weather data during daily distribution, in addition to the [**base rewards**](/rewards/reward-mechanism#daily-rewards-calculation-process). Learn more about the daily rewards in the [Reward Mechanism (RM) ](/rewards/reward-mechanism) section. + +**Reward Boosts** reward stations with extra $WXM tokens for meeting specific criteria. + +So far the following **Reward Boosts** are scheduled to be implemented: + +## Beta Rewards + +According to the [Token Allocation table](https://weatherxm.network/docs/wxm-token.html#token-allocation), 3M $WXM are reserved to reward stations that participated to the network before the Mainnet Launch Day ("Beta period"). + +Beta rewards distribution will last 425 days. + +### Calculation + +The following calculations will take place for each station, the day before the Mainnet Launch: + +$$RewardableBetaHours[i]$$: This is the total number of hours the station provided valid data during the Beta period. +A rewardable hour is an hour during which the station sent at least one valid weather data point. + +$$StationBetaRewards[i]$$: This is the percentage of the 3M tokens that correspond to the rewardable hours the station provided. +$$ +StationBetaRewards[i] = \frac{3000000 \times \text{RewardableBetaHours}[i]}{\sum (\text{RewardableBetaHours of all stations})} +$$ + +$$DailyBetaRewards[i]$$: This is the beta rewards allocated daily to this station. +$$ +DailyBetaRewards[i] = \frac{\text{StationBetaRewards}[i]}{365} +$$ + +## Beta Rewards Dilution - A fix + +Initially, the reward allocation formula caused dilution as the launch day was delayed, disadvantaging long-term station owners. + +### Updated Beta Rewards Allocation + +The updated approach involves calculating beta rewards twice: once at the end of February 2024 and again just at the end of the project's beta phase (May 27 2024). +Each station will receive the higher reward of these two calculations, ensuring fairer distribution of rewards across both old and new stations. + +Read more about the Beta Rewards Dilution fix [here](https://blog.weatherxm.com/a-fix-for-beta-rewards-dilution-493f1a81a28d). + +### Beta Rewards Table (BRT) + +The project's Beta period officially ended on May 27th (UTC). All station-hours accumulated up to this date are included in the final calculation and all stations are rewarded for participating in the Beta period with a daily Reward Boost. + +Download the BRT here: [CSV](https://weatherxm.network/wxm-brt-final.csv) + +:::info +Each user who has a station eligible for beta rewards, must have a wallet defined to be part of the Beta Rewards allocation. Learn [how to add or edit a wallet address](/mobile-app/wallet/add-edit-wallet-address). +::: + +:::note +The Beta Rewards allocation is managed by the [WeatherXM Network](https://weatherxm.network). +::: + +## Compensation Rewards + +Compensation Rewards are a special type of boost rewards which are meant to distribute tokens which were initially not allocated due to system and/or algorithm malfunctions. + +### Calculation Process + +For each day that an incident such as the above may have occurred, the correct network snapshot is reconstructed and the rewarding mechanism is re-ran in order to calculate +each station's intended reward score and consequently rewardable tokens. + +### Incident History + +| Date | Number of stations affected | Tokens Distributed | +|------|----------------------------|-------------------| +| 2025-02-03 | 5110 | 12186.48 $WXM | +| 2025-03-09 | 16 | 29.15 $WXM | +| 2025-05-01 | 7470 | 3923.771 $WXM | + +## Cell Bounties + +Cell Bounties are special incentives that boost rewards for weather stations deployed in high-priority areas and are funded by consumers and partners. + +:::info +Any currently open cell bounties may be viewed in [WeatherXM Explorer](https://explorer.weatherxm.com). +::: + +Stations which are deployed at bounty cells within the announced participation period will be eligible to receive extra rewards. Each bounty defines a maximum number of stations +which may share the rewards. Should the number of eligible bounty stations exceed the bounty capacity, a ranking based on [QoD scores](/weather-and-science/quality-mechanisms/general-qod-description) and seniority is used +to distribute rewards fairly. **Stations must meet a minimum of 0.8 QoD score to receive rewards**. + +## Examples of reward programs that may be implemented using **Rewards Boost**, in the near future are: + +- Public Goods Funding, for devices that are deployed and contribute to the network in a humanitarian way, such as providing data in an underserved area or during a specific time. +- Devices that contribute to the network during a specific event, such as a natural disaster, may receive a boost in rewards. + +:::tip +The **Reward boosts** is a mechanism that can be used to incentivise specific behavior from devices. It is a flexible mechanism that can be used to incentivise any behavior that is beneficial to the network. +::: + +:::info +All the above are **examples** of reward programs that may be implemented. +::: diff --git a/static/llms-pages/rewards/reward-mechanism.md b/static/llms-pages/rewards/reward-mechanism.md new file mode 100644 index 00000000..acef863b --- /dev/null +++ b/static/llms-pages/rewards/reward-mechanism.md @@ -0,0 +1,296 @@ +# Reward Mechanism + +Canonical: https://docs.weatherxm.com/rewards/reward-mechanism + +## Introduction + +:::info +The Reward Mechanism is currently at **version 2.0**. This page serves as both an informational resource about its current status and a how we got here. +::: + +The Reward Mechanism has undergone a progressive evolution across its versions, each iteration introducing refinements to bolster fairness and transparency in the rewarding process for weather station owners contributing data to the network. + +- In its inaugural version (v1.0), the mechanism primarily gauged a station's eligibility based on its connection status to the network and the requirement for active wallet ownership, resulting in a somewhat simplistic reward calculation. In this version, the users received in a daily basis the WXM testnet rewards at their wallets. +- The subsequent release, v1.5, marked a significant advancement by expanding the criteria for reward eligibility. This version incorporated additional factors such as the Data Quality, Proof-of-Location (PoL), Hardware-Classes (HC) and the Cell-Capacity (CP). + These additions contributed to a more sophisticated and equitable system, ensuring that rewards were allocated based on data quality, accurate location proof, and user engagement. +- The third iteration, v2.0, will introduce substantial enhancements, including the incorporation of Business Boost rewards and the implementation of a Merkle Tree structure for transparent reward distribution. The utilization of Merkle Tree will lead users in withdrawing, whenever they choose to do, their rewards from the smart contract. + Business Boost rewards added an additional layer of fairness by incorporating predefined criteria, while the Merkle Tree structure facilitated a verifiable and transparent mechanism for users to validate the distribution of their rewards. + This evolutionary trajectory underscores a commitment to refining the Reward Mechanism, making it more inclusive, nuanced, and transparent to build trust among weather station owners participating in the network. + +## Reward mechanism v2.0 + +The Reward Mechanism v2.0 is the latest iteration of the rewarding mechanism. It is a significant advancement over the previous version, v1.5, and it introduces the following enhancements: + +### High-level flow + +Every day, the reward algorithm assesses the performance of all weather stations, calculates additional rewards originating from Business Boost use cases, bundles them together with the users' wallet addresses, and creates a Merkle Tree, the root hash of which is submitted to the RewardPool. + +Users have the option to withdraw their rewards either by accessing the Merkle proof on the WeatherXM Platform or by retrieving the Merkle proof from IPFS and programmatically initiating the procedure. At any given time users have the flexibility to withdraw any amount they desire, provided it does not exceed the total allocated amount. + +### Daily Rewards Calculation Process + +The Reward Mechanism calculates the amount of tokens that will be allocated to users by completing the following phases: + +1. Base Rewards calculation +2. Business Boost Rewards calculation +3. Cumulative Rewards calculation +4. Merkle Tree creation + +Let's take a deep dive into each one of these. + +#### 1. Base Rewards calculation + +Base rewards calculation follows the **Actual Rewards Calculation** already introduced in **Reward Mechanism v1.5**. + +#### 2. Business Boost rewards calculation + +The business boost use cases reward specific devices with a predefined amount of tokens from the Business Development Pool for a period of time. In this phase, all business boost rewards are calculated for each active business boost use case and they are assigned to the eligible devices. + +#### 3. Cumulative Rewards Calculation + +In the third phase of the rewarding mechanism, the cumulative rewards per user are calculated. The cumulative rewards are the sum of all base and business boost rewards that each user's weather station owns. + +``` +cumulative_rewards_per_customer = sum(base_reward[i] + business_boost_reward[i]), i = 1..n where n = total number of devices per user +``` + +#### 4. Merkle Tree Creation + +In the final phase, the cumulative rewards coupled with the users' wallet addresses are utilised to create the Merkle tree. The root hash of the Merkle tree is submitted daily in the smart contract to enable $WXM rewards withdrawal by the users. + +#### Pseudocode + +To sum up all of the above in pseudocode: + +``` +// base reward +rewardable = { + 'Helium': { + count: 0, + weight: 0.9, + devices: [] + }, + 'M5': { + count: 0, + weight: 1.1, + devices: [] + } +} + +for cell in cells: + cell_devices = [] + for device in cell: + if isEmpty(device.owner.wallet): + device.reward_score = 0 + device.reward_reason = 'NO_WALLET' + device.base_reward = 0 + continue + if data_quality_score < data_quality_threshold: + device.reward_score = 0 + device.reward_reason = 'DATA_QUALITY_THRESHOLD' + device.base_reward = 0 + continue + if pol_score < pol_threshold: + device.reward_score = 0 + device.reward_reason = 'POL_THRESHOLD' + device.base_reward = 0 + continue + device.reward_score = reward_algorithm(device.pol_score, device.data_quality_score) + cell_devices.push(device) + rewardable[device.hardware_class].count += 1 + rewardable[device.hardware_class].push(device) + + cell_devices.sort( (x, y): + if x.reward_score == y.reward_score: + return x.claimedAt - y.claimedAt + return y.reward_score - x.reward_score + ) + + for (device, i) in cell_devices: + device.bb_reward = 0 + if i >= cell.capacity: + device.reward_score = 0 + device.reward_reason = 'MAX_CAPACITY_REACHED' + device.base_reward = 0 + +total_weights = 0 +for key in rewardable.keys: + hc = rewardable[key] + total_weights += hc.count * hc.weight + +for key in rewardable.keys: + hc = rewardable[key] + hc.max_rewards = daily_emission * hc.weight / total_weights + for device in hc.devices: + device.base_reward = device.reward_score * hc.max_rewards + +// business boost +for bb in business_boosts: + for device in bb.devices: + device.bb_reward += bb.daily_reward + +// cumulative calculation +for user in users: + daily_cumulative_rewards = 0 + for device in user.devices: + daily_cumulative_rewards = device.bb_reward + device.base_reward + if not user.active_wallet: + continue + user.wallets[user.active_wallet] = daily_cumulative_rewards + +// merkle tree +tree = [] +for user in users: + for wallet in wallets: + tree.push([wallet, user[wallet].cumulative]) + +// blockchain tx +submit(tree.root_hash()) +``` + +### Withdrawing Rewards + +Station owners have the freedom to withdraw their rewards at their discretion, without any time restrictions or other limitations. + +Each owner may initiate the withdrawal process by signing a transaction using the private key that corresponds to the blockchain address they have connected to their station. A user-friendly front-end that can be used in conjunction with a wallet like Metamask will be provided, but station owners can also interact programmatically with the **RewardPool** smart contract to withdraw their rewards directly. + +### Smart Contracts and Rewarding Mechanism + +The smart contracts and wallets associated with the rewarding mechanism are the following: + +* `WeatherXM`: ERC20 token +* `RewardPool`: smart contract holding users' allocated $WXM rewards +* `RewardVault`: smart contract holding the total amount of $WXM rewards to be allocated +* `BusinessDevelopmentPool`: wallet holding all $WXM leftovers from daily rewards + +The lifecycle of rewards from the rewarding mechanism to the users' wallets: + +* The **Reward Mechanism** calculates all rewards and allocates them to **RewardPool** +* The **RewardPool** holds all allocated rewards +* The **RewardVault** funds the **RewardPool** with the daily emission of $WXM +* The **Business Development Pool** funds daily the **RewardPool** with the business boost of $WXM +* The station owners withdraw their rewards programmatically or through the WeatherXM Platform by interacting with the **RewardPool** + +## Reward mechanism v1.5 +This section describes the updated **Reward Mechanism** that will be used to allocate $WXM rewards to station owners for contributing weather data to the network. (deprecated) + +:::note Important Notes +* Connecting a wallet is mandatory to receive rewards. If a user has not connected a wallet, the rewards will be lost. +* Criteria that should be met for a weather station to be rewardable: + * Data quality over data_quality_threshold + * PoL over pol_threshold + * weather station’s owner should have an active wallet + +::: + +### Daily Rewards Calculation Process +The Reward Mechanism calculates the amount of tokens that will be distributed to users by completing the following phase: + +#### Actual Rewards calculation +Actual rewards are calculated taking into account the performance of the weather station for the previous day. + +This is a short summary of the criteria used: + +* **Proof-of-Location (PoL)**: An algorithm that evaluates the data about the location of the weather station, its accuracy, consistency, and unison with the location the owner registered on the weather station claiming. +It generates a score that denotes confidence about the weather station's location. WeatherXM places great importance on station continuity, necessitating that a station remains stationed at a single location. +When a weather station undergoes relocation, its PoL score reduces to 0 and its seniority in the Cell is reset, aiming to discourage frequent movements and sustain a stable Network. Read more about the [Proof of Location (PoL) mechanism](/rewards/proof-of-location). + +* **Data Quality**: An algorithm that evaluates the quality of weather data provided by a weather station. It generates a score that denotes the confidence about the quality of the weather data for each weather station. + WeatherXM values weather stations that produce meaningful and usable data and the Data Quality score is an attempt to quantify this metric. The end goal is to encourage weather station owners to do their best to comply with WeatherXM's + guidelines in order to consistently achieve the best Data Quality score possible. Read more about the [Data Quality algorithm](/rewards/data-quality). + +* **Hardware-Class (HC)**: Each type of approved hardware (weather station) belongs to a specific Hardware Class. Hardware Classes are used to award more tokens to weather stations that have special capabilities, +increased sensor accuracy or range, new sensor types, or other capabilities that make them more valuable to the network. For the time being all Hardware Classes are considered equal. Read more about the [Hardware class](/rewards/hardware-class). + +* **Cell Capacity (CC)**: Each cell has a pre-defined **cell capacity** that depends on its geospatial characteristics. The cell's **capacity** is the maximum number of stations that may receive rewards in a specific cell. +If `N` weather stations are active in a cell with a capacity `X` during a specific day, with `N > X`, only the first `N` stations (ordered first by **reward_score**, then by seniority) will receive rewards. Read more about the [Cell Capacity (CC)](/rewards/cell-capacity). + +We will split the process into 5 distinct steps in an attempt to make everything as clear as possible. + +a. The following variables have known values at the start of each day: + +* `daily_emission`: the amount of tokens that are available for allocation on the given day +* `weight_per_hardware_class`: the number denoting how important an HC is compared to all the other HC +* `pol_threshold`: the number denoting the cut-off threshold for PoL: weather stations with `pol_score`` < pol_threshold` are **excluded** from rewarding +* `data_quality_threshold`: the number denoting the cut-off threshold for Data Quality: weather stations with `data_quality_score < data_quality_threshold` are **excluded** from rewarding +* `capacity` per cell: the maximum number of weather stations that will be rewarded in a cell - the rest are **excluded** from rewarding + +b. To calculate the rewardable count of devices per **HC**: + +* we exclude weather stations that are owned by users with no wallet address specified +* we count the weather stations with **data_quality_score** and **pol_score** over the respected specified thresholds, `data_quality_threshold`, `pol_threshold` The number of stations that pass this evaluation are eligible for rewards. + +c. To calculate the **max_reward_per_hardware_class (MRPHC)**: + +``` +total_weights = sum(rewardable_count_per_hardware_class[i] * weight_per_hardware_class[i]), i = 1..n, where n = total number of HC +``` + +For every HC: + +``` +tokens_per_hardware_class = daily_emission * (rewardable_count_per_hardware_class * weight_per_hardware_class) / total_weights + +max_reward_per_hardware_class = tokens_per_hardware_class / rewardable_count_per_hardware_class +``` + +d. To calculate the **reward_score** and **actual_reward**: + +``` +reward_score = pol_score * data_quality_score + +actual_reward = reward_score * max_reward_per_hardware_class +``` + +e. To identify overcrowded cells and decide which of the weather stations will be excluded from rewarding: + +* we iterate over available cells and check whether it is overcrowded +* in case it is indeed overcrowded, we sort the neighbouring weather stations first by `reward_score` and then by seniority (`claimed_time`). Only the `N` first will be rewarded, where `N = capacity` + +## Reward mechanism v1.0 + +The first iteration of **Reward Mechanism** operates in the following way: only taking into account whether or not a station is connected to the network. (deprecated) + +The reward distribution mechanism has two parts: + - **The reward algorithm** which calculates the `actual_reward` for each weather station by evaluating its weather data for the previous day + - The daily **reward distribution** of rewards to the station owners + +:::note Important +Connecting a wallet is mandatory to receive rewards. If a user has not connected a wallet, the rewards will be lost. +::: + +### How Often does the Reward Algorithm run? +The algorithm runs every day to reward weather stations that were actively sending data to the network for the previous day. + +### Calculation of the Reward Score +`reward_score = array_of_hourly_weather_data / 24` + +### Explanation +In the calculation of the `reward_score` step, the algorithm takes into account the weather data for each hour of the previous day for any given weather station. + - If the weather station has successfully sent data for each hour of the previous day, then the algorithm's input is an array of 24 objects, + with each object being the station's weather data. + - If the weather station hasn't sent any weather data for 1 or more hours the previous day, then the algorithm's input is an array of (`24 - X`) objects, + with each object being the station's weather data and `X` being the number of hours that the station hasn't communicated with our system. + +That input is then being used by dividing its length by 24 (the maximum hours per day) to get a `reward_score` of `0.0` to `1.0`. + +After the calculation of the `reward_score` step, the algorithm takes the `reward_score` for any given weather station in our network, multiplies it with the `max_daily_reward` that the weather +station can get, and the result is the amount of WXM tokens that the algorithm distributes to the user who owns that weather station. + +The formulas which are used to calculate the daily reward per weather station is the following: +``` +rewardable_count = Count(all_provisioned_weather_stations) +max_daily_reward = daily_emission / rewardable_count +weather_station_reward = reward_score * max_daily_reward +``` +### Reward Distribution Mechanism +All daily `actual_reward` per weather station are transferred to the wallet address already set by the user. +This is a bulk transfer operations which happens once in a daily schedule and as a result the users get their daily rewards to their wallets. +Due to blockchain limitations on the number of atomic transfer transactions that may take place with each bulk transfer, as many as needed bulk transfers can be executed for the purpose of everyone getting the daily rewards. + +## Links +- [WeatherXM Network](https://weatherxm.network/) +- [Data Quality algorithm](/rewards/data-quality) +- [Proof of Location (PoL) mechanism](/rewards/proof-of-location) +- [Cell Capacity (CC)](/rewards/cell-capacity) +- [Hardware class](/rewards/hardware-class) diff --git a/static/llms-pages/rewards/rewards-claiming.md b/static/llms-pages/rewards/rewards-claiming.md new file mode 100644 index 00000000..93d7e96b --- /dev/null +++ b/static/llms-pages/rewards/rewards-claiming.md @@ -0,0 +1,99 @@ +# How to Claim Rewards + +Canonical: https://docs.weatherxm.com/rewards/rewards-claiming + +:::tip +Allocated and claimed tokens displayed in our mobile apps, are only those linked to your current wallet. +This does not include any wallets you may have used in the past. +::: + +## Prerequisites for claiming rewards + +In order to claim your $WXM rewards: + +1. You must have a wallet with Arbitrum One network configured. If you have not done so, please follow the [Wallet Setup](/rewards/how-to-join-arbitrum-and-see-your-tokens). +2. You must have some ETH in your wallet which are needed as gas fees. + +
+ +## Claiming rewards + +To claim your rewards: + + + + + +1. Open the WeatherXM app. +2. Navigate to "My Profile" +![My Profile](image) + +3. Then press the "Claim" button. +4. Follow the instructions and "connect your wallet". +![connect_wallet](image) + +5. Enter the amount you want to claim and press "Next". +6. Then, follow the instructions on your wallet to confirm the transaction. + +**You have successfully claimed your rewards!** + +
+ + + + + +1. Navigate to the [Claim dApp](https://claim.weatherxm.com/). +![My Profile](image) + +2. Connect you Wallet. +3. Enter the amount you want to claim and press "Claim". + +4. confirm the transaction on your wallet. + +5. You have successfully claimed your rewards! + + + + + +### Alternative method for claiming rewards + +1. Navigate to the [Claim dApp](https://claim.weatherxm.com/). + ![My Profile](image) + +2. Connect your Wallet with the WalletConnect option. + ![Wallet Connect](image) + +3. Open your mobile wallet and scan the QR code with that wallet in order to connect with it. + + For example: Rainbow Wallet + ![Rainbow Wallet Scan QR](image) + +4. Enter the amount you want to claim and press "Next". + ![Enter Amount](image) + +5. Confirm the transaction on your mobile wallet. + ![Confirm Transaction](image) + +6. You have successfully claimed your rewards! + ![Claim Success](image) + +
+ +## Bridging your assets from Ethereum to Arbitrum + +1. Go to https://bridge.arbitrum.io/. +2. Then, simply enter the amount of ETH you wish to use on Arbitrum and click “Deposit”. +3. Next, you will need to confirm the transaction in your wallet. Please note that this transaction is on Layer 1 and standard gas fees will apply. +However, once on Arbitrum you can enjoy lower gas fees. Once the amount is correct, click “Confirm”. +4. Once confirmed, you will see the transaction appear and process at the bottom of your screen. This can take a few minutes. +5. If you require additional support to bridge your assets, you can refer to Arbitrum’s tutorial [here](https://docs.arbitrum.io/getting-started-users). + + **This Guide is applicable only on desktop with the MetaMask browser extension already installed.** diff --git a/static/llms-pages/rewards/rewards-troubleshooting.md b/static/llms-pages/rewards/rewards-troubleshooting.md new file mode 100644 index 00000000..2e9cf535 --- /dev/null +++ b/static/llms-pages/rewards/rewards-troubleshooting.md @@ -0,0 +1,218 @@ +# Rewards Troubleshooting + +Canonical: https://docs.weatherxm.com/rewards/rewards-troubleshooting + +A guide to interpreting mobile app error messages, understanding their meanings, and taking appropriate actions to resolve them. + +## No wallet + +It seems that you haven't connected a wallet to your account yet. Please note that in order to receive rewards, you must connect a wallet address. Here's what you need to do: + +1. Learn [how to add or edit a wallet address](/mobile-app/wallet/add-edit-wallet-address). +2. Then, follow the instructions for [joining Arbitrum One and see your $WXM tokens](/rewards/how-to-join-arbitrum-and-see-your-tokens). + +Once you've completed the above steps, you'll be all set to claim your rewards. Please wait until the [Reward Mechanism (RM) ](/rewards/reward-mechanism) completes. This usually takes until the following day and see "[How to Claim Rewards](/rewards/rewards-claiming)" for further guidance. + +
+ +## No Station Data + +It seems that your station did not transmit any data at all, which may indicate that it was either offline or not connected to the network. + +Here's what you need to do: + +### For the WG1000 WiFi gateway + + + +

WG1000 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS receiver.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/m5/troubleshooting#weather-station-not-reporting-data-to-wg1000-gateway-there-are-dashes----on-the-display-console). +- Also read through the guide to add the included external antenna [here](/wxm-devices/m5/troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- Check if the station's battery level is low through mobile app settings. +If the battery is low, the connection between your station and the WG1000 gateway will be unstable resulting in data loss. + + + + +- Check your GPS by following the guide [here](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red). +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/m5/troubleshooting#no-wifi--connection). + +### For the WS2000/WS2001 (Helium version) + +1. Check if the station's battery level is low through mobile app settings. +2. Check for [Helium coverage](/wxm-devices/helium/troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. + +
+ +## Sensor Problems + +If you got this error, it means our data evaluation services detected that the received weather packets, did not meet our quality standards. +To ensure the accuracy of the information sent by our weather stations, we evaluate all data packets using our [Data Quality algorithm](/rewards/data-quality). For more information about this algorithm, please refer to this [here](/rewards/data-quality). + +Below are some of the possible errors and the appropriate actions you can take to resolve the issues: + +#### Out of Bounds Data +It's possible that a sensor sends a completely irrational value, which implies to a faulty sensor. If this error persists for multiple days, it is recommended to perform a complete **power cycle**. + +##### Power cycle procedure: +1. Remove batteries. +2. Cover the solar panel so the station isn't powered by the panel while the batteries are out. +3. You should wait 48 hours for the stored power to fully drain. +4. Put batteries back in place and wait for the station to boot up. + +If the above doesn't work, you should contact our [support team](https://support.weatherxm.com) for sensor replacement. + +#### Spikes on Data +One or more of your sensors are exhibiting irrational spikes. You should first check your station if it is optimally deployed and then you should contact [support](https://support.weatherxm.com). +Take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. + +#### Constant Values +One or more of your sensors report constant values which implies a bad installation, or less often, a problematic sensor. If your station is optimally installed and the constant value errors persist for a few days, +you should perform a **power cycle** and if you continue to receive it, contact [support](https://support.weatherxm.com). + +Take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. + +##### Power cycle procedure: +1. Remove batteries. +2. Cover the solar panel so the station isn't powered by the panel while the batteries are out. +3. You should wait 48 hours for the stored power to fully drain. +4. Put batteries back in place and wait for the station to boot up. + +If the above doesn't work, you should contact our [support team](https://support.weatherxm.com) for sensor replacement. + +#### Frozen Sensor +You should remove excess snow or ice from the weather station, and make sure wind cups and wind vanes rotate freely. + +:::tip +If you encounter any errors, it is recommended that you observe it for a few days before reaching out to our [support team](https://support.weatherxm.com). +In case you still receive the error after a couple of days, please do not hesitate to contact our [support team](https://support.weatherxm.com) for further guidance. +::: + +
+ +## Weather Data Gaps + +Some data gaps were detected during our data quality checks. +Perhaps the indoor or outdoor units are not properly connected to the network, or to each other. + +Here's what you need to do: + +### For the WG1000 WiFi gateway + + + +

WG1000 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS receiver.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/m5/troubleshooting#weather-station-not-reporting-data-to-wg1000-gateway-there-are-dashes----on-the-display-console). +- Also read through the guide to add the included external antenna [here](/wxm-devices/m5/troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- Check if the station's battery level is low through mobile app settings. +If the battery is low, the connection between your station and the WG1000 gateway will be unstable resulting in data loss. + + + + +- Check your GPS by following the guide [here](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red). +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/m5/troubleshooting#no-wifi--connection). + +### For the WS2000/WS2001 (Helium version) + +1. Check if the station's battery level is low through mobile app settings. +2. Check for [Helium coverage](/wxm-devices/helium/troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. + +### For the WG1200 WiFi Gateway + + + +

WG1200 Gateway icons explanation
+ Red=Problem, Green= Good

+
    +
  1. RF connection with the station.
    2. +
  2. Connection to WeatherXM Network.
    3. +
  3. GPS Receiver of the Weather Station.
    4. +
  4. WiFi connection.
    5. +
+ + +- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/d1/troubleshooting#device-alert-no-weather-station-signal). +- If the station's battery level a warning will appear on the [WG1200 Gateway](/wxm-devices/d1/troubleshooting#one-or-more-variables-are-extremely-high-low-or-constant-for-long-periods-of-time). +- In case your WG1200 GPS arrow icon is red, please contact our [support team](https://support.weatherxm.com) for further guidance. +- Follow the Troubleshooting guide regarding [No WiFi connection](/wxm-devices/d1/troubleshooting#device-alert-no-internet-connection). + +
+ +## Bad Station Deployment + +It appears that your weather station could benefit from some improvements in terms of its deployment. The [Data Quality algorithm](/rewards/data-quality) evaluates all data packet received by a weather station every day, so a proper installation becomes mandatory to receive the maximum amount of rewards. +We recommend that you take a look at our [Deployment Examples](/wxm-devices/deployment-examples) and [Best Practices](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) for inspiration on how and where to install your station. + +
+ +## No location Data + +Your weather station was suspended from rewards because it did not report GPS data. Please check the troubleshooting guides for your station below, before contacting our support team.[support team](https://support.weatherxm.com). + +### For the WG1000 - WiFi gateway + +1. [No location (GPS) data (arrow icon is red)](/wxm-devices/m5/troubleshooting#no-location-gps-data-arrow-icon-is-red) +2. [Place the WG1000 near a window (for better GPS signal)](/wxm-devices/m5/connect-and-claim#place-wg1000-gateway-near-a-window-for-better-gps-signal) + +### For the WS2000/WS2001 (Helium version) + +1. [No location (GPS) data](/wxm-devices/helium/troubleshooting#no-location-gps-data) +2. [Installation instructions](/wxm-devices/helium/install-weather-station) + +
+ +## Location Not Verified + +It appears that the location of your weather station is different from the one you had originally set while claiming it. +Please verify your location through the mobile app. + + + + + +In detail, the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flagged your weather station because the location reported by its GPS receiver(s) is different than the location you declared during the setup and claiming of the station. + +This could happen because either you have moved your station from its initial installation site, or you had declared a wrong location during the onboarding process of the station on your mobile app. + +As a result, your station will not be eligible for reward distribution until it is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. + +:::tip +When discussing the weather, we always mention a specific location, either directly or indirectly. Therefore, the data provided by weather stations in the WeatherXM Network is meaningless unless we know the location of each station at all times. +It is crucial for the stability of the Network to have weather stations that can report their current location and remain stationary. +::: + +:::note +[Proof of Location (PoL) mechanism](/rewards/proof-of-location) penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: + +
+ +## User Relocation Penalty + +Our [Proof of Location (PoL) mechanism](/rewards/proof-of-location) reported a relocation event. +It seems like you used the relocation feature and you edited the location of your weather station through the app. Please wait 7 days and your weather station will start earning rewards again. + +WeatherXM places great importance on station continuity, and discourage relocations therefore It is important for the Network that a station remains at the same location throughout its lifetime. + +:::note +The [Proof of Location (PoL) mechanism](/rewards/proof-of-location) penalty imposed to devices that went through a relocation is currently reduced to 2 days. This is a temporary measure and will be reverted back to 7 days. +::: diff --git a/static/llms-pages/tokenomics.md b/static/llms-pages/tokenomics.md new file mode 100644 index 00000000..95bd405c --- /dev/null +++ b/static/llms-pages/tokenomics.md @@ -0,0 +1,79 @@ +# The $WXM Token + +Canonical: https://docs.weatherxm.com/tokenomics + +## The token that enables the WeatherXM ecosystem + +$WXM, issued by the [WeatherXM Network Association](https://weatherxm.network/), is the token that enables the WeatherXM ecosystem. + +\$WXM will be used to govern the Network and will be required to license weather data for commercial uses. Station owners are awarded \$WXM for providing high-quality weather data to the Network. + +View detailed analytics about the $WXM token, including rewards and revenue, on [Dune Analytics](https://dune.com/weatherxm/network-stats). + +## Tokenomics + + **$WXM** is an ERC20 token to power the weather data economy. + +:::note +WeatherXM is deployed on Arbitrum One Network. You can find the contract at [Arbitrum One Explorer](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6) +::: + +### New approach in crowdsourcing weather data +WeatherXM creates an entirely new weather data economy that rewards the people who deploy and maintain weather stations. +$WXM is currently implemented in [Arbitrum One](https://arbiscan.io/token/0xb6093b61544572ab42a0e43af08abafd41bf25a6) as an ERC20 token. + +Like most networks, the value of our Network is greater than the sum of its parts. Station owners are rewarded with $WXM tokens (governance participation) based on the data they contribute on a daily basis. + +To implement this logic, we introduce a smart contract that distributes a fixed budget of tokens (the \$WXM token) to station owners and other stakeholders daily. Any customer who wants to use the Network’s data or services will have to acquire \$WXM. + +### $WXM Token Distribution + +**Total supply of the $WXM token is 100M (100,000,000) tokens.** + +#### 55% - Station Rewards: +Tokens will be used for station owners rewards. 3M of this amount will be used to gradually reward beta users. + +#### 30% - Initial Supporters: +30M tokens will be allocated to initial supporters of the project. These tokens will be locked and they will be unlocked during a period of four (4) years, linearly with one year cliff. + +#### 10% - Treasury +10M tokens will be allocated to the DAO treasury to support the WeatherXM ecosystem development. Tokens will be unlocked linearly during a 5 year period, starting from the day of the token launch. + +#### 5% - Liquidity support: +5M tokens will be provided to token exchanges as a way to allow other interested parties to join the WeatherXM ecosystem governance and/or license data. + +#### 3% Beta Rewards: +3 million tokens will be used to reward stations that contributed data to the Network during the beta phase. This is not a marketing activity intended to create buzz and awareness, but a reward mechanism for the stations that participated and formed the Network before a reward mechanism was in place. + +More specifically, the 3,000,000 tokens will be allocated to stations based on the percentage of rewardable station-hours each station provided to the Network. + +A rewardable station hour is an hour during which the station sent at least one valid weather data package to the network. Proof-of-Location (PoL) is not taken into account during the calculation of the Beta Rewards. + +This provides an additional incentive for the early Network adopters to remain in the network, maximising their station data value due to seniority and providing additional incentive for early members to actively participate in future Network governance. + +:::note +To understand better the "Beta rewards" you can read the related blog post [here](https://blog.weatherxm.com/beta-user-rewards-b2e27b1727d7). +::: + +### Token Emissions + +**Distributed over the next 10 years** + +WeatherXM is a long-term project. The total supply of 100M $WXM tokens is unlocked and distributed based on a predefined 10-year schedule. + +The token distribution is designed to incentivise station owners to provide data to the Network and to reward early supporters of the project. + +All tokens will be minted on token launch. More specifically: +- 52M tokens will be distributed to station owners every day for providing data to the Network. +- 30M tokens will be allocated to initial supporters of the project +- 3M tokens will be distributed to station owners that participated in the Network during its beta phase. See more at [Reward Boosts](/rewards/reward-boosts.mdx) +- 10M tokens are reserved in the Association's treasury. They will be used to support the WeatherXM ecosystem development. +- A one-off issuance of 5M tokens will take place on token launch. These tokens will be used to provide market liquidity. + +### Locked tokens +- **Treasury** tokens will be locked and they will be unlocked linearly during a 5 year period, starting from the day of the token launch. +- **Initial Supporters** tokens will be locked and they will be unlocked linearly during a four (4) year period with one (1) year cliff. + +:::tip +You can always read more at the [WeatherXM Network](https://weatherxm.network/) website. +::: diff --git a/static/llms-pages/weather-and-science.md b/static/llms-pages/weather-and-science.md new file mode 100644 index 00000000..d34084a4 --- /dev/null +++ b/static/llms-pages/weather-and-science.md @@ -0,0 +1,21 @@ +# Weather And Science + +Canonical: https://docs.weatherxm.com/weather-and-science + +## Weather And Science at WeatherXM + +Welcome to the **Weather And Science** section — a hub for our scientific work, technical studies, and exploratory projects in meteorology and atmospheric science. +Here you’ll find **peer-reviewed papers, whitepapers, technical reports, and experimental findings** from the WeatherXM team and our collaborators. + +Our research spans multiple domains, including: +- **Hyperlocal Weather Data** — methods for collecting, validating, and analysing data from our global network of weather stations. +- **Forecasting & Modelling** — blending traditional meteorological models with machine learning techniques to improve prediction accuracy. +- **Climate & Environmental Insights** — studying long-term patterns, microclimates, and the effects of extreme weather events. +- **Web3 & Weather Data Economics** — exploring decentralised data marketplaces, tokenised incentives, and the future of open-access meteorology. + +By publishing our findings openly, we aim to: +- Contribute to **global scientific understanding** of weather and climate. +- Support **innovation in open-source meteorology**. +- Empower developers, researchers, and enthusiasts to **build on our work**. + +Whether you’re a scientist, a developer, or simply curious about how technology can transform weather science — you’ll find something here to explore, learn from, and use. diff --git a/static/llms-pages/weather-and-science/decompensating-ws2000-temperature-offset.md b/static/llms-pages/weather-and-science/decompensating-ws2000-temperature-offset.md new file mode 100644 index 00000000..ebe165ad --- /dev/null +++ b/static/llms-pages/weather-and-science/decompensating-ws2000-temperature-offset.md @@ -0,0 +1,299 @@ +# Decompensation of WS2000 temperature offset + +Canonical: https://docs.weatherxm.com/weather-and-science/decompensating-ws2000-temperature-offset + +Dr. Stavros Keppas, 30/10/23 - WeatherXM AG + +## 1. Introduction to the issue +In the period February-August 2023 as the duration of daylight was gradually increasing together with the temperature, we observed larger and larger differences in temperature between WS2000 and FosHK WS69 (Figure 1). In particular, the temperature of WS2000 was constantly lower, exclusively during the day, compared to FosHK WS69. The results of our previous analysis showed that WS2000 temperature (TWS2000) was systematically decreased (compared to FosHK WS69) under certain temperature and illuminance regimes. As we additionally compared FosHK WS69 with Davis VP2 weather station, we concluded that WS2000 was eventually underestimated temperature during a typical summer day in mid-latitude areas. This issue needs to be addressed for increasing the reliability and accuracy of WS2000, but also for rehabilitating the uniformity of measurements over the WeatherXM network. + + + + + **Figure 1**. The FosHK WS69 and WS2000 weather station models that were used for data analysis. + + +Our speculation was confirmed by the manufacturer, who provided a ruleset that is followed for decreasing temperature under certain temperature, illuminance and wind speed thresholds (**Table 1**). + + + + **Table 1**. The initial correction algorithm thresholds. + + +## 2. Data and methodology +### a. The Datasets +We employed 8 FosHK WS69/WS2000 couples of weather stations located in three different cities (in Greece and Texas, US) in urban and suburban areas. In each of the couples, both FosHK WS69 and WS2000 are deployed under same conditions (e.g., on a same-height metallic mast within a distance of a few metres). For the analysis, we used temperature, illuminance and wind speed data from the period February-August 2023. We highlight that +WS2000 provides data in 3-minute timesteps, while FosHK WS69 in 16-seconds timesteps. For this reason, the FosHK WS69 data were averaged in 3-minute intervals. + +### b. The Simple De-Compensation +In order to reverse the result of the algorithm shown in Table 1, we applied the recommended corrections shown in Table 2. However, we should highlight here that the upper temperature threshold in each of the classes should be adjusted as a function of the temperature correction of the next class. As an illustration, the first class should be between 25.5-30°C, the second between 30-34.5°C and in case of wind speed <1m/s it should be 30-34°C. However, in the present analysis we examine the recommended algorithm shown in **Table 2**. + + + + **Table 2**. Decompensation algorithm thresholds. + + +### c. The Linear-Polynomial Regression (LPR) De-Compensation +As an alternative method, we developed a relationship for temperature correction via the ‘LinearRegression’ tool from the ‘sklearn.linear_model’ module in python. In order to develop the relationship, 5 of the 8 FosHK WS69/WS2000 couples were randomly chosen and used for training the relationship, while the other 3 were used for testing (Table 3). It is noted that we exclusively used data points that correspond to TWS2000 >25.5°C and illuminance>3000Lux. This means that the following methodology is applied only on data that fulfill these criteria. + + + + **Table 3**. Abbreviation names of locations of which the weather station couples were used for testing of the LPR model.. + + +As the decompensation is mostly affected by the initial temperature measured by the WS2000, we developed one main relationship. + +a. For IWS2000 > 13000Lux and 25.5°C < TWS2000 < 35.5°C, equation 1 is applied: + +**Tdecomp = -0.00463155*TWS2000 +1.3758184*TWS2000 -5.950001094966307 (**Equation 1**)** + +Where: +TWS2000 is the WS2000 temperature in °C. +IWS2000 is the WS2000 illuminance in Lux. + +The equation comes with r2 = 0.98 and Mean Square Error (MSE) = 0.15. + +b. For 3000lux < IWS2000 ≤ 10000Lux and TWS2000 ≥ 36°C, equation 2 is applied: + +**Tdecomp = 0.7907*TWS2000 -0.0911 * WSWS2000 +0.00025863*IWS2000 +6.8931 (**Equation 2**)** + +Where: +TWS2000 is the WS2000 temperature in °C, +WSWS2000 is the WS2000 wind speed in m/s, +IWS2000 is the WS2000 illuminance in Lux. + +Considering that TWS2000 is always below or equal to the true temperature (e.g. as measured by WS69) and in order to avoid any unreasonable extrapolation of this relationship, we cut off any cases that Tdecomp - TWS2000 <0°C setting finally Tdecomp = TWS2000. We also keep always Tdecomp - TWS2000 <1.5°C and <2°C when WSWS2000 is <1m/s and ≤1m/s respectively. + +The equation comes with r2 = 0.71 and MSE = 0.17. + +c. For IWS2000>13000lux and TWS2000>36°C that we are certain about the process: + - For WS>1m/s: + Tdecomp = TWS2000 + 1.5°C (**Equation 3**) + - For WS≤1m/s: + Tdecomp = TWS2000 + 2°C (**Equation 4**) + +To avoid any steep and unrealistic changes in temperature on the application boundaries of the above equations, we suggest a simple transition between the WS2000 temperature and the Tdecomp. + +a. We allow a transition when 24.5°C < TWS2000 ≤ 25.5°C and IWS2000 > 13000Lux: + + Tdecomp = (1 - Tweight)*TWS2000 + Tweight * Equation1 (**Equation 5**) + + Where: + Tweight = (TWS2000 - 24.5) + +b. For the transitional area of illuminance when 24.5°C < TWS2000 ≤ 25.5°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - Iweight)*TWS2000 + Iweight*((1 - Tweight) * TWS2000 + Tweight * Equation1) (Equation 6) + + Where: + Iweight = (IWS2000 - 3000)/10000 + +c. And also for the case that 25.5°C < TWS2000 ≤ 35.5°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - IWS2000)*TWS2000 + IWS2000 * Equation1 (**Equation 7**) + +d. In case that 35.5°C < TWS2000 ≤ 36°C and 3000Lux < IWS2000 ≤ 13000Lux: + + Tdecomp = (1 - Iweight)*TWS2000 + Iweight * Equation1 (**Equation 8**) + + When 35.5°C < TWS2000 ≤ 36°C and IWS2000 > 13000Lux - for WSWS2000>1m/s + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation3 + + - for WSWS2000 ≤ 1m/s +Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation4 +Where: +Tweight_up = (TWS2000 - 35.5) / 0.5 + +e. When 35.5°C < TWS2000 ≤ 36°C and IWS2000 > 13000Lux - for WSWS2000>1m/s + + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation3 (**Equation 9**) + + - for WSWS2000 ≤ 1m/s + Tdecomp = (1 - Tweight_up)*Equation1 + Tweight_up*Equation4 (**Equation 10**) + + Where: + Tweight_up = (TWS2000 - 35.5) / 0.5 + +f. When TWS2000>36°C and 10000Lux < IWS2000 ≤ 13000Lux: - for WSWS2000>1m/s + + Tdecomp = (1 - Iweight_up)*Equation2 + Iweight_up*Equation3 (**Equation 11**) + + - for WSWS2000 ≤ 1m/s + Tdecomp = (1 - Iweight_up)*Equation2 + Iweight_up*Equation4 (**Equation 12**) + + Where: + Equation2 is the temperature arising from the Equation 2, but always keeping Tdecomp - TWS2000 between 0-1.5°C or 0-2°C for WSWS2000 >1m/s and ≤1m/s respectively as previously described. + + For the python script of this approach see **Appendix A**. For detailed information regarding the rationale behind selecting this set of equations, see **Appendix B**. Finally, a broad range of values of the involved parameters was used for testing various combinations and edge cases. This analysis is described in **Appendix C**. + +## 3. Results +Here, we compare the temperature time series of a WS69 station (which we consider as reference) with temperature time series from WS2000 (without any decompensation), Simple Decompensation and LPR decompensation in order to choose the most accurate approach of temperature decompensation. +Firstly, we present some problematic cases (mentioned in **Appendix B**) to have a detailed look at the behaviour of each of the approaches. + + - On 16/7/2023 (at SE_1 location) (**Figure 2**) that WS2000 temperatures during the day were fluctuating around 30-32°C, it can be noticed that the Simple Decompensation provides an increased variation, when WS2000 fluctuates around 30.5°C (which is one of the compensation thresholds - see **Table 1**). The LPR method offers a more realistic reconstruction of the temperature, which is usually closer to WS69 temperature. Indeed, LPR decompensation temperature RMSE is lower by 0.19°C and Tmax difference from WS69 is lower by 0.2°C compared to Simple Decompensation method. Certainly, the compensated WS2000 temperature seems to be way off the WS69 temperature. + + + + **Figure 2**. Temperature on 16/07/2023 recorded by TS_1 WS69 (black), WS2000 (red) weather stations. The WS69 is considered as the reference. The Simple Decompensation (yellow) and LPR approaches are also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux. RMSESimple_Decomp = 0.72°C, TmaxSimple_Decomp = 32.3°C, RMSELPR = 0.53°C, TmaxLPR=32.6°C, TmaxLWS69R = 32.9°C. + + + - On 23/7/2023 (at TS_1 location) (**Figure 3**), it is noticed a sudden increase (~2°C) in WS2000 temperature under illuminance values of 3000-13000Lux (at 16-18UTC time), while WS69 temperature gradually decreases. An intense fluctuation (~2°C) is also observed in simple decompansation temperature. The LPR method seems to provide a more realistic representation of the temperature with an ~1°C increase and a much smoother fluctuation. Again, RMSE is lower for the LPR method and maximum temperature of the day is closer to that of WS69. Similarly, in **Figure 4**, where temperature is shown during a hot day (19/8/2023) in one of the stations (Texas, US) used for the training of the LPR approach, the fluctuation of LPR method (at 23-00UTC time) seems to be more realistic with less (in number) fluctuations compared to the Simple Decompensation approach. Although, in this case we exhibit results coming from a couple of weather stations used for training purposes, we aim to highlight the behaviour of the approaches over such high temperatures (that were observed only in this couple of stations). + + + + **Figure 3**. Same as in figure 2 for 23/7/2023. RMSESimple_Decomp = 0.7°C, TmaxSimple_Decomp = 39.4°C, RMSELPR = 0.6°C, TmaxLPR=39.4°C, TmaxWS69 = 39.8°C. + + + + + **Figure 4**. Same as in figure 2 for 19/8/2023. The location of the station couple is situated at Texas (US) and the stations were used for training of LPR. RMSESimple_Decomp = 0.66°C, TmaxSimple_Decomp = 42.7°C, RMSELPR = 0.6°C, TmaxLPR=42.7°C, TmaxWS69 = 42.2°C. + + +Our next step towards the evaluation of the two decompensation methods is to examine the entire warm period (May-August 2023) of TS_1, TS_2 and TS_3. Data before May 2023 were excluded in order to remove any noise in our results, as there are no significant issues for temperatures <26°C. It should be noted again that WS69 temperature was used for reference. As shown in **Table 4**, the compensated WS2000 temperature always exhibits the higher RMSE, MAE and the lower R2. In contrast, the LPR method produces the lowest RMSE and MAE (0.57°C and 0.21°C respectively) together with the impressive R2=0.99. The simple decompensation, although it partly fixes the temperature issue, is still worse than LPR result. + + + + **Table 4**. Root Mean Squared Error (RMSE), Mean Absolute Error (MAE) and R2 between WS69 temperature and WS2000, Simple Decompensation and LPR temperature for the warm period 05-08/2023 for each of the locations SE_1, SE_2 and SE_3. The average of these locations for these statistical metrics is shown in the row ‘Avg’. The scores in this table have been generated using only rows of data where WS69 temperature was <25.5°C. + + +Then, we wanted to investigate the differences in Tmax and Tavg to show the significance of the issue (**Table 5**). The initial compensated WS2000 daily maximum temperature (Tmax) presented ~1.2°C deviation from WS69 temperature. While the simple decompensation dropped this difference to 0.3°C by the simple decompensation, the LPR eliminated this difference (0°C). Regarding the Tavg, the differences are lower (as temperatures <25.5°C are involved in the calculations). However, both Simple Decompensation and LPR eliminate the difference from WS69. + + + + **Table 5**. Average Tmax for the period May-August 2023 for the 3 test locations (SE_1, SE_2, SE_3) as observed by WS69 and WS2000 and calculated by Simple Decompensation and LPR methods. The last row of the table shows the average difference in daily Tmax and Tavg between WS69 and one of the WS2000, Simple Decompensation and LPR temperature time series. + + +We also investigated the difference between average temperatures (including only data rows with WS69 temperature <25.5°C) and the corresponding standard deviations (**Table 6, Figure 5**) for each of the test locations (**Table 3**). It seems that the WS2000 compensated temperature differs by 0.63-0.72°C, the simple decompensation temperature differs by 0.14-0.45°C and the LPR temperature by -0.1 to 0.11°C. In addition, WS2000 exhibits the largest standard deviation (0.65-0.72°C) and the simple decompensation lower standard deviations (0.37-0.45°C). However, the LPR temperature presents the lowest standard deviation (0.32-0.41°C). These results imply that LPR average temperature (for WS69 temperatures <25.5°C) is closer to WS69 temperature than the simple decompensation. Furthermore, it seems that the LPR method demonstrates the lowest variation of temperature differences from WS69. + + + + **Figure 5**. Summarisation of the results of Table 6. Markers indicate the average difference of mean temperature between WS69 and WS2000, simple decompensation and LPR methods (for WS69 temperature <25.5°C), while the error bars depict the corresponding standard deviation. + + +## 4. Conclusions +In this report, we employed 8 couples of WS69/WS2000 weather stations to compare and test decompensation methods for fixing the temperature issue that we detected in a previous report considering as reference (or ground truth) the temperature received from WS69. As we detected serious issues when we applied the Simple Decompensation algorithm, we decided to develop a linear-polynomial regression (LPR) model to efficiently decompensate temperature differences, finding the trends and patterns of such differences. We used 5 couples for training our model, while the rest 3 were used for testing purposes. We finally concluded that the LPR model: + - Do not enhance the temperature variations, when WS2000 temperature fluctuates around the thresholds used for the initial temperature compensation. Instead, LPR produces a much smoother and realistic result. + - Produces smoother and realistic temperature variations before the sunset of a warm day smoothing the unreasonable and sudden temperature increase of WS2000. + - Comes with the lowest RMSE (0.6°C) and MAE (0.23°C) and with the impressively highest R2 (0.99). + - Eliminates the significant temperature differences between WS2000 and WS69. + - Provides the lowest average difference from WS69 for temperatures <25.5°C (-0.1 to 0.11°C) and the most limited variation of the differences with a standard deviation of 0.33-0.41°C. + +Hence, we highly recommend that the LPR method should be applied on raw temperature observations of WS2000 in order to fix this temperature issue and restore the uniformity of our weather station network. + +## Appendix A +The LPR method code has been written in the following python script. Note that the inputs for the temperature calculation are illuminance (lux) in Lux, wind speed (wind) in m/s and temperature (temp) in °C as recorded by WS2000. The algorithm should be applied on every single sampling interval. + +Below is your function, **formatted as valid Python** and wrapped in an MDX code block so you can literally copy-paste it into your `.mdx` file. + +> ⚠️ Because the code came mangled from the PDF (things like `return ... elif ...` on the same line, missing newlines etc.), I’ve reconstructed the indentation and line breaks so it is real Python. Please double-check the logic against your original source. + +δηλαδή να φαίνεται το ```python κλπ σαν κείμενο, τότε χρειάζεσαι nested fences: +**έξω 4 backticks (mdx), μέσα 3 backticks (python)**. + +Βάλε αυτό στο `.mdx` σου: + +```mdx +```python +def linear_regression(lux, wind, temp): + # For the temperature area between 25.5 and 35.5 + if temp > 25.5 and temp < 35.5 and lux > 13000: + return 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + + elif temp > 25.5 and temp < 35.5 and lux > 3000 and lux <= 13000: + weight = (lux - 3000) / 10000 + return (1 - weight) * temp + weight * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + # For the transitional temperature area between 24.5 and 25.5 + elif temp > 24.5 and temp <= 25.5 and lux > 13000: + weight = (temp - 24.5) / 1.0 + return (1 - weight) * temp + weight * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + elif temp > 24.5 and temp <= 25.5 and lux > 3000 and lux <= 13000: + weight_lux = (lux - 3000) / 10000 + weight_temp = temp - 24.5 + return (1 - weight_lux) * temp + weight_lux * ( + (1 - weight_temp) * temp + + weight_temp + * (1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307) + ) + + # For the transitional temperature area between 35.5 and 36 + elif temp >= 35.5 and temp < 36 and lux > 3000 and lux <= 13000: + weight_lux = (lux - 3000) / 10000 + return (1 - weight_lux) * temp + weight_lux * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + + elif temp >= 35.5 and temp < 36 and lux > 13000: + weight = (temp - 35.5) / 0.5 + if wind <= 1: + return (1 - weight) * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + weight * (temp + 2) + else: + return (1 - weight) * ( + 1.3758184 * temp - 0.00463155 * temp * temp - 5.950001094966307 + ) + weight * (temp + 1.5) + + # For the temperature area >= 36°C + elif temp >= 36 and lux > 13000: + if wind <= 1: + return temp + 2 + else: + return temp + 1.5 + + elif temp >= 36 and lux > 3000 and lux <= 10000: + temp1 = 0.7907 * temp - 0.0911 * wind + 0.00025863 * lux + 6.8931 + + if temp1 - temp < 0: + temp1 = temp + elif temp1 - temp > 2 and wind <= 1: + temp1 = temp + 2 + elif temp1 - temp > 1.5 and wind > 1: + temp1 = temp + 1.5 + + return temp1 + + elif temp >= 36 and lux > 10000 and lux <= 13000: + temp1 = 0.7907 * temp - 0.0911 * wind + 0.00025863 * lux + 6.8931 + + if temp1 - temp < 0: + temp1 = temp + elif temp1 - temp > 2 and wind <= 1: + temp1 = temp + 2 + elif temp1 - temp > 1.5 and wind > 1: + temp1 = temp + 1.5 + + weight = (lux - 10000) / 3000 + + if wind <= 1: + return (1 - weight) * temp1 + weight * (temp + 2) + else: + return (1 - weight) * temp1 + weight * (temp + 1.5) + + else: + return temp +``` + +## Appendix B +In this section we highlight the reasons that led us to train and develop a linear-polynomial model for decompensating the TWS2000. The basic issues that make the simple decompensation method problematic are: + - The simple decompensation method applies a fixed offset to temperature values within specific temperature ranges, without considering whether the TWS2000 has previously undergone correction as per the process and thresholds outlined in **Table 1**. Consequently, there is uncertainty surrounding the accuracy of temperature observations. For instance, a temperature reading of 25.6°C may not definitively represent 25.6°C, as it might have originally been 26.1°C before undergoing compensation. + - We found that TWS2000 increases significantly when illuminance is around 8000Lux. Although **Table 1** recommends changes in temperature only when illuminance is >8000Lux, it seems that there are cases where temperature steeply increases under slightly higher illuminance for unknown reasons that need further investigation. In particular, in **Figure 6**, TWS2000 is 40°C around 00:00UTC and although TWS2000 and TWS69 are getting close (as it usually occurs for illuminances <8000Lux), in fact illuminance is still >8000Lux, which causes an unreasonable temperature peak when applying the simple decompensation method. + - When TWS2000 fluctuates around one of the compensation boundaries (see **Table 1**) (e.g., around 30.5°C), the decompensation process tends to amplify these fluctuations. This amplification results in unrealistic variations in temperature, causing the readings to appear artificially elevated and then sharply reduced, leading to inaccuracies in the recorded temperature values (**Figure 7**). + + + + **Figure 6**. Temperature on 09/08/2023 recorded WS69 (black), WS2000 (red) weather stations in Texas (US). The WS69 is considered as the reference. The Simple Decompensation (yellow) is also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux + + + + + **Figure 7**. Temperature on 16/07/2023 recorded by TS_1 WS69 (black), WS2000 (red) weather stations. The WS69 is considered as the reference. The Simple Decompensation (yellow) is also shown. Purple dots indicate the period of the day that illuminance is between 3000-13000Lux + + +## Appendix C +To ensure that there are no undesirable results of the LPR method in extreme cases, we plotted several graphs to test it among the ranges of temperature illuminance and wind speed provided by the WS2000 manufacturer, which are -40≤TWS2000≤80°C, 0≤IWS2000≤200000Lux and 0≤WSWS2000≤50m/s. Figures 7-9 show that the difference TLPR-TWS2000 remains always ≥0°C, but also does not exceed 2°C in cases where any case. diff --git a/static/llms-pages/weather-and-science/obstacle-impact-on-temp-and-wind.md b/static/llms-pages/weather-and-science/obstacle-impact-on-temp-and-wind.md new file mode 100644 index 00000000..f8096e87 --- /dev/null +++ b/static/llms-pages/weather-and-science/obstacle-impact-on-temp-and-wind.md @@ -0,0 +1,75 @@ +# Obstacle Impact on Temperature and Wind + +Canonical: https://docs.weatherxm.com/weather-and-science/obstacle-impact-on-temp-and-wind + +# Obstacle Impact on Temperature and Wind +Dr. Stavros keppas, 12/08/2025 + +We installed two weather stations on a rooftop to investigate how nearby walls and other obstacles might affect weather measurements. One station, our reference station (considered the reliable installation, see **Figure 1, Station A** - WS1000), was placed at the highest point of the roof, where there were no obstacles taller than the station that could interfere with its readings. The second station, the “obstructed” installation in our experiment (see **Figure 1, Station B** - WS1001), was placed in a location (see Figure 3) where: + +- To the east, a wall 3 m taller than the station is located 5 m away (instead of 21–30 m as suggested by ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- To the west-northwest, a small structure at a similar height as the station, with solar water heaters adding 2 m in height, is located ~5 m away (instead of 21-30m that it should according to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- To the northwest, a triangular wall 2 m taller stands 8–9 m away. +- The south-southwest horizon is relatively open (instead of 21-30m that it should be according to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious))). +- The southern horizon is completely open without obstacles. + +For the data analysis, we used **air temperature, wind speed and direction, and solar irradiance**. +- For temperature, we used summer data (10/05/2025–10/08/2025), when urban surfaces are more thermally stressed. +- For wind, we used a longer time series (10/11/2024–10/08/2025) to provide a larger sample. + + ![Experimental setup](image) + + **Figure 1**. The experimental setup with the two stations. Station A is used as a reference and free-of-obstacles + station, while station B is used as the problematic and to-be-investigated station that is surrounded by + significant obstacles. + + +## Temperature Impact + +Regarding temperature, although the wind sample is not evenly distributed across all directions (due to the local climatology, some wind directions occur more or less frequently), there appears to be a pattern that can be explained by the station’s surroundings. More specifically (**Figure 2**): + +- The largest positive temperature differences (with the 90th percentile of biases ranging from 0.34°C to 0.99 °C) are observed when the wind blows from directions where there is an obstacle (thus from north, northeast, east, southwest, west, and northwest). +- Qualitatively, the graphs suggest that the largest positive deviations usually occur when the sun is positioned in the southern or southwestern part of the sky (solar azimuth). At this solar azimuth, the incident solar radiation on the east-facing wall is at or near its maximum, resulting in the greatest potential heating of the surface. +- For winds from the south and southeast, the temperature differences are usually negative or close to zero (−0.92 °C to -0.13 °C). + +This behaviour could be explained by the fact that when wind is blocked by an obstacle, the heat stored in the wall is not dispersed by air circulation, so the air on the sheltered side of the wall warms up more. On the other hand, when wind flows towards the obstacle, it removes heat from the surface, and the nearby air becomes cooler. + +The frequently negative differences in these cases may be due either to differences between the sensors or to the fact that south of Station B there is no concrete (as it is located at the edge of a five-storey building), while south of Station A there are concrete rooftop surfaces that emit some heat. To explain this case a bit deeper, air tends to acquire the thermodynamic properties of the surface it passes over. Although the short distance involved would normally limit significant changes in these properties, in low wind conditions air can theoretically remain over a surface for longer and acquire new thermal characteristics. It should again be emphasised that the unequal sample sizes for each wind direction may reduce the confidence of these conclusions. + + ![Experimental setup](image) + + **Figure 2**. Relationship between temperature measured by station A (Obstacle Free) and station B (Wall Obstacle) for + grouped wind directions. The markers are coloured by the solar azimuth. The median, 10th–90th percentile and the + number of the considered sample is shown in the in-plot frames. For the analysis only data coinciding with + Illuminance >5000Lux (40W/m2) were used to investigate the impact of solar radiation heating on + measurements. The data were aggregated in 10-min intervals to securely identify the wind direction. + + +## Wind Impact + +The effects of obstacles on wind measurements are much more distinct and easier to interpret. The obstacles around Station B (**Figure 3**) are clearly reflected in the wind rose (**Figure 4**): + +- Average wind speeds from the north through to the east-southeast sector (0-135°) are significantly lower at Station B (by up to >1.5 m/s), especially from the east-northeast direction, where the main wall is located. +- In the east-southeast directions, wind speed at Station B tends to recover slightly but still remains lower. This is likely because the wall continues to have some influence on the overall air circulation and flow. Additionally, when winds are from the east, their actual direction may fluctuate between NE and SE, but the measured speed remains reduced due to friction with obstacles and because both wind speed and direction have been averaged over one-minute intervals. +- In the west to west-northwest sector (225-292.5°), although the obstacles there appear less substantial, they still have a significant effect, reducing speeds by up to 1 m/s. +- The absence of obstacles to the south is clearly visible: for winds from the south-southeast to southwest sector, average wind speeds are comparable between both stations. +- Obstacles to the north and north-northwest appear to have a smaller impact on measurement quality, likely because they are further away and not continuous, with openings through which air can occasionally pass. +- Overall, Station B consistently records lower average wind speeds, even from directions where the horizon is free of obstacles. This is likely because it is installed closer to the rooftop surface, where friction between the air and surfaces is stronger (**Figure 5a**). Additionally, for southerly winds, the airflow approaching the building may be deflected upward upon encountering the structure, reducing the speed recorded by the station (**Figure 5b**). + + ![Experimental setup](image) + + **Figure 3**. The surrounding area of station B. The free-of-obstacle, partly blocked and blocked directions are indicated + by green, orange and red lines together with the pointing direction. + + + ![Experimental setup](image) + + **Figure 4**. Wind rose showing the average wind speed per cardinal direction for Station A (Obstacle Free) and Station B + (Wall Obstacle). 10-min wind averages were used for the plot. + + + ![Experimental setup](image) + + **Figure 5**. Qualitative and simplistic schemes of air flow and wind speed (a) above a horizontal surface + ([NASA](https://www.grc.nasa.gov/www/k-12/VirtualAero/BottleRocket/airplane/boundlay.html)) and (b) a building + ([AIVC.org](https://www.aivc.org/sites/default/files/airbase_866.pdf); [WMO](https://library.wmo.int/viewer/68661/?offset=31#page=501&viewer=picture&o=bookmark&n=0&q=)). diff --git a/static/llms-pages/weather-and-science/quality-mechanisms.md b/static/llms-pages/weather-and-science/quality-mechanisms.md new file mode 100644 index 00000000..5c4c7041 --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms.md @@ -0,0 +1,16 @@ +# Quality Mechanisms + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms + +# Quality Mechanisms + +In this section, all the available quality mechanisms are fully described. + +## Contents + +- [**General QoD Description (OBC-SQC, ISD, SPV)**](/weather-and-science/quality-mechanisms/general-qod-description): General and brief description of all the available quality mechanisms. +- [**Indoors Station Detector (ISD)**](/weather-and-science/quality-mechanisms/isd-full-documentation): Full documentation of the Indoors Station Detector (ISD), which is the mechanism that detects stations placed indoors, but also some other problematic situations. +- [**OBC and SQC Annotations**](/weather-and-science/quality-mechanisms/obc-sqc-annotations): Description of the annotations produced by the OBC-SQC quality mechanism. +- [**Out-of-Bounds (OBC) and Self Quality Checks (SQC)**](/weather-and-science/quality-mechanisms/obc-sqc-documentation): Full documentation of the Out-of-Bounds Check (OBC) and Self-Quality-Check (SQC) mechanism, which focuses on the detection of suspicious data in the transmitted raw data. +- [**OBC and SQC Score Calculation**](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation): The method of the final daily OBC-SQC score calculation. +- [**Station Photo Verification (SPV)**](/weather-and-science/quality-mechanisms/spv-full-documentation): Full documentation of the Station Photo Verification (SPV) mechanism, which aims to evaluate the station deployments via photos. diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/constancy-analysis-report.md b/static/llms-pages/weather-and-science/quality-mechanisms/constancy-analysis-report.md new file mode 100644 index 00000000..b4210e0e --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/constancy-analysis-report.md @@ -0,0 +1,38 @@ +# SQC - Constancy Analysis Report + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/constancy-analysis-report + +# Constancy Analysis Report +Dr. Stavros Keppas, 21/09/2023 + +One of the sub-processes within the Self-Quality-Check (SQC) of the Quality of Data (QoD) mechanism involves the examination of data to identify instances where it appears suspiciously unchanging for extended durations. According to ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)) guidelines, constant temperature, relative humidity (RH), wind, and pressure data, should be flagged as suspicious if they remain constant for longer than one hour, with the exception of RH, which applies only when it exceeds 95%. + +## 1. Data and Method + +To ensure that we tailor these criteria to match the specifications of WeatherXM’s weather stations and to flag not suspicious but actually erroneous data, we utilised up to one year of data (09/2022 to 09/ 2023, where available) from 18 well-deployed weather stations at various locations (coastal, continental, lowland, hilly at various latitudes) (**Figure 1**). This extensive dataset allowed us to assess the constancy of key parameters, namely temperature, RH, and wind speed, which are prone to remaining unchanged for prolonged periods. + + ![Experimental setup](image) + + **Figure 1**. Locations of the weather stations used for the constancy analysis. + + +The datasets were averaged over 1 minute intervals, which corresponds to the "ignoring period" (during which we populate empty rows with data to facilitate Quality of Data processes - see [QoD documentation section 1](/weather-and-science/quality-mechanisms/obc-sqc-documentation#1-filling-ignoring-period---filling-no-data-slots)) chosen in the Quality of Data (QoD) mechanism. Then, we determined the duration of time during which consecutive observations remained at a certain value. + +## 2. results + +Here, we examine the patterns and correlations among three parameters (temperature, RH and wind speed), when they exhibit prolonged periods of constancy. The objective of this analysis is to identify meteorological conditions that may explain why a parameter remains constant for extended hours. Conversely, it inevitably seeks to highlight conditions that are less conducive to the persistence of constant values over extended periods. + +The analysis reveals that temperature tends to remain constant for relatively brief periods, typically less than 100 minutes (**Figure 2**). Nevertheless, there were instances where the duration exceeded 200 minutes, coinciding with RH levels surpassing 95%. Therefore, it is advisable to establish a conservative threshold for constancy duration, setting it at 240 minutes, while median RH does not exceed 95%. + + ![Experimental setup](image) + + **Figure 2**. Duration of constant temperature (in minutes) versus median wind speed for the period of constancy. + The scatter points are coloured based on the median relative humidity observed during the same constancy period. + + +RH exhibits a capacity to remain constant for significantly longer durations compared to temperature (**Figure 3**). In certain instances, RH can remain constant for over 2000 minutes. However, when examining constancy durations exceeding 305 minutes, it becomes evident that the median RH was consistently ≥95%. Therefore, it is advisable to establish a constancy threshold of 360 minutes for cases where the median RH is <95%. + + + + **Figure 3**. Duration of constant relative humidity (in minutes) versus median temperature for the period of constancy. + The scatter points are coloured based on the median relative humidity observed during the same constancy period. diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/general-qod-description.md b/static/llms-pages/weather-and-science/quality-mechanisms/general-qod-description.md new file mode 100644 index 00000000..1931e6c5 --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/general-qod-description.md @@ -0,0 +1,83 @@ +# General QoD Description (OBC-SQC, ISD, SPV) + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/general-qod-description + +# General QoD Description (OBC-SQC, ISD, SPV) + +At the moment, there are three data quality mechanisms being applied at WeatherXM. These mechanisms are designed to assess both the quality of the data itself and the status of the station deployments. Each mechanism follows a different approach to evaluate the reliability of a station’s data, and they ultimately work complementarily, contributing to a more comprehensive evaluation of each station. Although the final result of these data quality mechanisms affects user rewards, their primary objectives are: +- To determine which stations produce data reliable enough to be used internally by the company, as well as by third-party companies and organizations as a product. +- To motivate users to improve their deployments, aiming for the highest possible measurement quality. +- To ensure that the data is of high enough quality to be used for improving the weather forecasts that WeatherXM produces at station locations. + +Currently, the following three data quality mechanisms are used to classify and assess stations and their data: +- Out-of-Bounds Check (OBC) and Self Quality Check (SQC) +- Indoors Station Detector (ISD) +- Station Photo Verification (SPV) + +## Out-of-Bounds Check (OBC) and Self Quality Check (SQC) + +Both OBC and SQC aim to detect suspicious data at the raw, minute, and hourly level. This means that these mechanisms can identify unusual variations in different station parameters caused by faulty deployments or malfunctioning sensors, when such variations occur and when the prevailing meteorological conditions allow them to be detected. + +For example, a sudden temperature change caused by using a very short mast that keeps the station too close to the surface of a rooftop will be detected primarily on a calm day with alternating sunshine and cloud cover. Under such conditions, the station will record very abrupt temperature changes; otherwise, detection would not be possible. + +OBC and SQC therefore flag specific raw data points that appear suspicious (they do not label an entire deployment as problematic). These two mechanisms run within a unified algorithm every day, assessing the data from the previous day. The checks performed are as follows: + +**A. Out-of-Bounds Check** +OBC is a simple process that involves identifying values that fall outside the specifications set by the manufacturer for each sensor. As an example, if the temperature sensor is able to measure within a temperature range of -60 to 60°C, then the value 80°C is considered as faulty. + +**B. Self Quality Check (SQC)** +This mechanism uses the data from the station itself (and therefore does not rely on third-party data for comparison) to detect unexpected changes in various parameters, which may be due either to poor placement of the weather station or to a malfunction in one of its sensors. + +The checks performed are: +- **Check for stagnation** (lack of variability) in the parameters. For example, a constant recording of zero wind speed and an unchanging wind direction for six hours, combined with low relative humidity, is an indication that the station is located in a place where air circulation is not as expected, or that the anemometer has frozen (if the temperature has been >0°C for several hours). +- **Check for suspicious spikes** over short time intervals, which may occur either due to poor station placement or because of a faulty sensor. For example, a temperature change >3°C within 1 minute is considered unrealistic. If the station’s sampling interval is greater than 1 minute, the respective threshold is increased linearly, provided that the sampling rate remains below 10 minutes. +- **Check for gaps in the data**. Each station model, according to its specifications, is capable of sending data packets at a specific time interval. If the number of packets received on an hourly basis is lower than the threshold set by the specifications, this indicates a problem in data transmission (e.g., poor 4G/Wi-Fi/Helium signal). + +Similar checks (for stagnation and spikes), but with different time windows (based on WMO –[Guide to the Global Observing System (WMO-No. 488), pg.200](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)– guidelines as well as our [own data analysis](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)), are carried out for all parameters (see [full documentation](/weather-and-science/quality-mechanisms/obc-sqc-documentation)). + +Finally, the ratio of invalid to expected valid data is calculated on an hourly basis in order to determine the final score of successful meteorological observations. + +## Indoors Station Detector (ISD) + +The ISD is a mechanism primarily aimed at identifying stations that are active but have not been placed outdoors. However, there is a range of other classifications that can be assigned to a station’s deployment status. The ISD mechanism runs once per day and evaluates the data from the entire previous day, but for the final evaluation result it also takes into account the outcomes from the last seven days in order to provide a fairer classification of the station’s deployment. The key difference compared to OBC-SQC is that ISD evaluates the entire day as a whole, assigning a single annotation related to the station’s deployment status. + +For deployment assessment, the ISD uses solar radiation analysis techniques, comparing actual measurements with theoretical radiation values for each location on the planet and for each day of the year. In parallel, various combined thresholds are applied to temperature, wind direction/speed, and relative humidity (thresholds derived from exploratory data analysis) in order to identify certain significantly problematic deployment cases. It should be noted, however, that ISD is able to detect only a small subset of problematic deployments, as its main focus is on identifying stations that are located indoors. The classifications resulting from the ISD mechanism are shown in Table 1. See full [ISD documentation here](/weather-and-science/quality-mechanisms/isd-full-documentation). + +Table 1. ISD annotations, their short description, and their impact on the quality score. +Note that the short description is statistically derived, and the actual status of the station may differ. + +| ISD Annotation | Short Description | Impact on Score | +|----------------------------|-----------------------------------------------------------------------------------|-----------------| +| OUTDOORS | Well deployed | NO | +| INDOORS | In a house or a very closed area | YES | +| ALMOST INDOORS | In a closed area e.g., a balcony | YES | +| BAD DEPLOYMENT | In an area surrounded by significant obstacles | YES | +| PROBABLY BAD DEPLOYMENT | In an area that has some obstacles that may affect mainly wind, precipitation and solar irradiance observations | YES | +| INCLINED POLE NORTH | On a north-tilted pole or the light sensor needs cleaning | YES | +| INCLINED POLE EAST | On an east-tilted pole | YES | +| INCLINED POLE SOUTH | On a south-tilted pole | YES | +| INCLINED POLE WEST | On a west-tilted pole | YES | +| PROBLEMATIC LIGHT SENSOR | Weird spikes in solar irradiance | NO | +| REPLACE ILLUMINANCE | Solar irradiance is always 0 | YES | +| ALMOST NIGHT | The station is located in a high-latitude region that experiences darkness during the winter months, with little to no sunlight | NO | +| INDOORS FROZEN | The station looks like indoors due to freezing conditions | NO | +| INDOORS ALMOST FROZEN | The station looks like indoors almost due to freezing conditions | NO | +| BAD DEPLOYMENT FROZEN | The station looks like bad deployment due to freezing conditions | NO | +| PROBABLY DEPLOYMENT FROZEN | The station looks like probably bad deployment due to freezing conditions | NO | +| UNKNOWN | Less than 40% of the expected data during the period of the day with solar irradiance >0.1 W m−2 | NO | + +## Station Photo Verification (SPV) + +At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO) (see also [our obstacle experiment](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx)). The SPV mechanism evaluates the deployment of each station as depicted in the photos submitted by the user through the mobile app. Through SPV, seven key aspects of the photos are examined in order to assess both the overall deployment and the extent to which each parameter can be measured accurately. This mechanism assigns a score to the station each time the user submits a set of photos, which is then evaluated internally by company staff. The 7 aspects and how they affect the SPV score are described in Table 2. Each aspect is assessed separately based on the condition shown in the photo under evaluation, unless an issue is identified that affects the station’s measurements regardless of orientation. Each photo receives a score for each of the 5 aspects that can be scored, and then the average score per photo is calculated. Finally, the average score of the 4 photos (one for each cardinal direction) is computed, which determines the final SPV score. It should be noted that if there is no photo for a specific cardinal direction, the score for that direction is considered to be zero. The SPV scoring rules and guidelines are comprehensively described in [this document](/weather-and-science/quality-mechanisms/spv-full-documentation). + +Table 2. The SPV aspects, their short description and the available score options. + +| SPV Aspect | Short Description | Score Options | +|------------------------------|-----------------------------------------------------------------------------------|---------------| +| Photo Validity | Evaluation of whether the photo meets the standards set by the company | 0, 0.5, 1 | +| Temperature/Relative Humidity| Evaluation of the validity of the temperature and relative humidity measurements | 0, 0.5, 1 | +| Wind | Evaluation of the validity of the wind measurements | 0, 0.5, 1 | +| Precipitation | Evaluation of the validity of the precipitation measurements | 0, 0.5, 1 | +| Solar Irradiance | Evaluation of the validity of the solar irradiance measurements | 0, 0.5, 1 | +| Mast Height | Evaluation of the relative mast height in relation to the objects in the surrounding area | - | +| Mast Inclination | Classification of a visibly tilted mast toward a specific direction | - | diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/isd-full-documentation.md b/static/llms-pages/weather-and-science/quality-mechanisms/isd-full-documentation.md new file mode 100644 index 00000000..585b2fbc --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/isd-full-documentation.md @@ -0,0 +1,262 @@ +# Indoors Station Detector (ISD) + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/isd-full-documentation + +# Indoor Station Detector (ISD) + +## 1. Introduction + +Indoors Station Detector (ISD) is a component of the Quality of Data (QoD) mechanism that is responsible for scoring the quality of the weather data and the deployment of the weather stations. + +The ISD is a component of the Self Check process (meaning that it exclusively relies on data from the weather station and does not utilise data from third-party sources). Originally, ISD is designed to identify, and eventually characterise, weather stations that are deployed indoors (i.e., inside houses, boxes, closets, etc.), which is reflected in its name. While being designed, ISD has evolved to also detect stations located in enclosed areas (e.g., balconies), places with significant obstacles, and on tilted poles. + +The ISD primarily relies on the parameter of solar irradiance. Therefore, without sufficient data of this parameter, ISD cannot make a decision about a station's deployment. Although the main comparison is between observed and theoretical solar irradiance, the analysis of wind, temperature, and relative humidity (RH) variances contribute significantly to the final decision. The final outcome of the ISD component is a characterisation of the weather station's deployment, which is provided daily and reflects the variations in the collected weather measurements. This characterisation can be used to determine whether specific parameters can be trusted. It’s important to note that atmospheric pressure measurements are valid, even when a weather station is located indoors. + +## 2. ISD Categories + +While the ISD was initially designed to identify only indoor stations, the experimentation with solar irradiance measurements has enhanced its capabilities, enabling it to detect a wider range of problematic cases and categories. These include: + + 1. Outdoors + 2. Indoors + 3. Indoors Almost + 4. Bad Deployment + 5. Probably Bad Deployment + 6. Inclined Pole North + 7. Inclined Pole East + 8. Inclined Pole South + 9. Inclined Pole West + 10. Problematic light sensor + 11. Replace Illuminance + 12. Almost Night + 13. Indoors Frozen + 14. Indoors Almost Frozen + 15. Bad Deployment Frozen + 16. Probably Bad Deployment Frozen + 17. Unknown + 18. No firmware version + +In the next paragraphs there is a comprehensive explanation of the 17 different ISD categories. + +a. **OUTDOORS**. A station of the “OUTDOORS” category should observe a significant amount of solar irradiance through the day, and reasonable variations in temperature, RH, wind speed and wind direction (**Figure 1**). + + + + **Figure 1**. Temperature (blue) and Relative Humidity (green), Observed (light red) and Theoretical (dark red) Solar Irradiance, wind speed and wind direction of a station fell into the “OUTDOORS” category on 24/4/2024. + + +b. **INDOORS**. These stations are identified as being placed indoors (within a house, etc.) or in highly enclosed areas with significant obstacles that strongly affect the weather observations. This determination is based on the observation of low solar irradiance, as well as unreasonably low variations in wind speed/direction, temperature, and relative humidity, which are not expected in an open area environment (**Figure 2**). Consequently, the reliability of all observed variables from these stations is highly questionable. + + + + **Figure 2**. Same as Figure 1, but for a weather station that fell into the “INDOORS” category. + + +c. **INDOORS_ALMOST**. This category includes stations that seem to have reasonable variations in temperature and relative humidity through the day. However, even these two parameters may have a significant offset from the ground truth. Even if temperature and humidity looks reasonable, the reliability of the remaining observed variables from these stations is highly questionable (Figure 3). Such stations are considered to be in very closed areas (such as balconies or indoors next to an open window etc). Although this category is similar to the ‘INDOORS’, it actually indicates the probability that a station is surrounded by ‘fresh air’. + + + + **Figure 3**. Same as Figure 1, but for a weather station that fell into the “INDOORS ALMOST” category. + + +d. **BAD_DEPLOYMENT**. In this category, stations appear to be poorly deployed. As an illustration, a station can typically be surrounded by significant obstacles that may affect not only the sensitive-to-obstacles parameters like wind and precipitation, but also temperature and humidity. It is highly likely that solar irradiance remains at unreasonably low levels throughout the day, with wind speed and direction exhibiting low variations, and even prolonged periods of calm conditions (**Figure 4**). If any data from these stations were to be utilised, it would only be for the parameters of temperature and relative humidity. However, even the reliability of these parameters remains uncertain. + + + + **Figure 4**. Same as Figure 1, but for a weather station that fell into the “BAD DEPLOYMENT” category. + + +e. **PROBABLY_BAD_DEPLOYMENT**. In this category, the weather stations do not always measure the expected variations in their measurements indicating that the deployment may be poor and some significant obstacles around may prevent from recording reliable measurements. Temperature and relative humidity readings should be used cautiously. Precipitation and wind speed/direction data may be unreliable, particularly when air flows from certain but (at the moment) unspecified directions. Solar irradiance readings are also not reliable. In general, any issues with the station would be mostly evident in the parameters related to solar irradiance and wind (**Figure 5**). The distinction from the "BAD_DEPLOYMENT" category lies in the deployment’s capacity to record higher solar irradiance throughout the day. + + + + **Figure 5**. Same as Figure 1, but for a weather station that fell into the “PROBABLY BAD DEPLOYMENT” category. + + +f. **INCLINED_POLE_***. Stations in this category are positioned on tilted poles. To account for the various tilt directions, there are four distinct categories, each identified by a letter at the end (N, E, S, W) that indicates the direction in which the pole is tilted relative to the horizon. In the specific case where a station falls into the ‘INCLINED_N’ category, this could be attributed to either a tilted pole or a dusty light sensor. A weather station can be classified into one of these categories only on cloudless days, when we can obtain a well-defined bell-shaped solar irradiance curve time series for comparison with the theoretical curve. Classification is not feasible on overcast or partly cloudy days (**Appendix A1 - Figure 11**). + +g. **PROBLEMATIC_LIGHT_SENSOR**. Within this classification, the recorded solar irradiance consistently registers at 0W/m2. This may occur due to a faulty sensor, the presence of snow or other thick materials covering the sensor, or prolonged night in high latitudes during the winter. Although a constancy check is implemented in QoD v1 components, instances where solar irradiance remained consistently at 0 W m−2 were excluded. This exclusion arose from the uncertainty regarding whether the stations are located in areas that experience near-continuous nighttime for 24 hours each day. This ambiguity can now be addressed in ISD by comparing the data with theoretical solar irradiance. Since such faulty solar irradiance measurements cannot assist in taking any decisions under these circumstances, these stations are excluded from the ISD process. +In this category, stations constantly report a solar irradiance of 0W/m2, a behaviour that cannot be explained by the theoretical solar irradiance (**Figure 6**). Although our analysis did not reveal any stations with unusual variations in temperature, relative humidity, or wind speed/direction, as the time series data from these stations cannot undergo the ISD process, there remains the possibility that these stations may be unreliable. + + + + **Figure 6**. Same as Figure 1, but for a weather station that fell into the “PROBLEMATIC ILLUMINANCE” category. + + +h. **REPLACE_ILLUMINANCE**. In this category, observed solar illuminance exhibits irrational spikes, usually out-of-bounds. Such solar irradiance measurements are not valid and these stations are excluded from the ISD process. Such issues may also be detected by QoD v1.0, allowing for the results from the different QoD components (Out-Of-Bounds -OBC-, Self Quality Check -SQC- and ISD) to be cross-verified. + + + + **Figure 7**. Same as Figure 1, but for a weather station on 10/10/2023 that fell into the “REPLACE ILLUMINANCE” category. + + +i. **ALMOST_NIGHT**. There is no way to determine the condition of a deployment through the ISD when the daily mean solar irradiance is <5 W m−2 (**Figure 8**), as the solar irradiance signatures we seek cannot be detected under these conditions. Stations located in high latitudes are typically expected to measure very low temperatures or may even be completely frozen. This category is used to distinguish between stations that are located in artificially dark conditions and those that are affected by physically prolonged dark conditions. + + + + **Figure 8**. Same as Figure 1, but for a weather station on 21/11/2024 that fell into the “ALMOST NIGHT” category. + + +j. ***_FROZEN**. If a station falls into one of the categories ‘INDOORS’, ‘INDOORS_ALMOST’, ‘BAD_DEPLOYMENT’, or ‘PROBABLY_BAD_DEPLOYMENT’, and the **(TMD)** is <0.5°C, then this station is reclassified into the same category but with the suffix ‘_FROZEN’. This method aims to exclude potential false positives caused by frozen sensors, such as low solar irradiance readings from a light sensor covered by snow. + +k. **UNKNOWN**. Stations that provide less than 40% of the expected data packets, during the period that solar altitude is greater than 7°, fall into this category. This occurs because the solar curve cannot be adequately represented, making it difficult to determine whether any significant obstacles are present near the station (**Figure 9**). + + + + **Figure 9**. Same as Figure 1, but for a weather station that fell into the “UNKNOWN” category. + + +l. **NO FIRMWARE VERSION**. If the firmware version is missing, it becomes unclear whether the solar irradiance value has been corrected. An uncorrected solar irradiance value is multiplied by 10, which could cause the ISD to mistakenly classify the deployment as faulty. However, this is an annotation for internal use only and it does not affect user's rewards. + +## 3. The Method + +### 3.1 Parameters + +The method is primarily based on solar irradiance measurements in order to compare them with the [theoretical solar irradiance](/weather-and-science/r&d/theoretical-solar-radiation.mdx) for a given location and day (Nijegorodov, 1996; Ahmad and Tiwari, 2011). The theoretical solar irradiance algorithm returns the following parameters: + +a. (SIthe): the diurnal theoretical solar irradiance under clear sky conditions (W/m2) +SIthe is one of the most important parameters for ISD and it is produced for every single location, day of the year and hour of a day. It is the reference parameter for evaluating how reasonable the levels and the variations of the **observed solar irradiance** are throughout the day. Typically the observed solar irradiance (SIobs) is lower than the theoretical. Nevertheless, during a partly cloudy day, solar irradiance spikes may significantly exceed the theoretical curve due to the “Cloud Enhancement” phenomenon caused by the Mie Scattering effect (Jarvela et al., 2020). + +b. **SA (Solar Altitude)**: the angular elevation of the center of the solar disk above the horizontal plane (degrees) +SA is useful for filtering the observations of a station, when solar measurements are too low to be usable. + +After: a. cleaning (SIthe) and (SIobs) from NaNs, b keeping only the solar data corresponding to SA >7° in order to exclude the near-zero/zero values and c. keeping only the solar data for which (SIthe) >0.1(W/m2) and (SIobs) is not NaN, we derive the following solar irradiance dependent parameters: +- **Daily average ratio between (SIthe) and (SIthe) ((RatioSIOT_daily))** (which ranges between 0 and >1). In properly deployed weather stations, the expected value is typically &ht;1. However, very low values, such as <0.05, raise concerns and suggest that the weather station may not be properly deployed. Very high values (e.g., >1.5) suggest a probably faulty light sensor. +- **Daily average of SI_the (SIthe_daily_avg)** (W/m2). Days with average SI_the <5W/m2 are considered as days that ISD cannot effectively detect problematic deployments. +- **Daily maximum of SI_the (SIthe_daily_max)** (W/m2) +It is used indirectly to calculate thresholds of statistical metrics (like residual standard error and correlation coefficient of solar irradiance measurements - see parameters i and j) to determine some of the criteria that a station falls into a problematic class. +- **Count ratio between observed and theoretical solar irradiance (CRSI_OT)**, which is the ratio between the number of the non-nan SIobs and the number of the SIthe when SIthe > 0 W/m2 +This is one of the most important parameters that makes the first filtering. Weather stations that observe 0 W/m2 for long periods through a day, while the theoretical solar irradiance suggests values > 0W/m2 are considered as suspicious. +- **Standard Deviation of of observed SI_obs (SIobs_sd)** (W/m2) +It is a good indicator for distinguishing between problematic deployments with low solar irradiance (low variance of solar irradiance due to significant obstacles or indoors placement) and non-problematic ones during overcast (larger variance of solar irradiance as the thickness of clouds varies through a day allowing less or more light to reach the light sensor) +- **Percentage of NaN SI_obs elements (PSI_ON_AN)** (%) versus the total number of the SI_obs elements +This is a simple ratio that indicates the availability of observations. To make decisions based on solar irradiance data, we need to have a sufficient amount of data. Therefore, we set the availability threshold at 40%. +- **Correlation coefficient** between observed and theoretical solar irradiance (**ccOT**) +This metric is utilised in the calculations for the inclination criterion. High values of this metric indicate a strong similarity between theoretical and observed solar irradiance, which typically occurs in a well-deployed station on a cloudless day. +- **Residual Standard Error (RSE)** between the observed solar irradiance measurements and the polynomial fit of 5th order on them (W/m2) +RSE is valuable for identifying completely cloudless days, which can help in detecting tilted masts. Low RSE indicates small deviations of the SIobs from the polynomial fit, which is characteristic of cloudless days. +- **Correlation coefficient threshold (ccOT_thres)** +It is empirically calculated and ranges between 0.990 and 0.995 for a corresponding SIthe_daily_max range of 400 to 700 W/m2. The relationship between the two is cubic. +- **RSE threshold (RSEthres)** (W/m2) +It is empirically calculated and ranges between 5 and 50 for a corresponding SIthe_daily_max range of 5 to 1000 W/m2. The relationship between the two is quartic. +- **Inclination criterion**, which consists of two sub-parameters, the **inclination** (Inclined/Normal) and the **inclination orientation** (N/E/S/W) +This parameter indicates whether the pole is tilted (inclination) and the direction of the tilt (inclination orientation). + +We also clean from NaNs and use the parameters of **temperature, RH, wind speed and wind direction** to support the ISD analysis. +We then calculate the following metrics based on the non-solar parameters mentioned above: +- **Temperature standard deviation (TSD)** (°C) It has been observed that low temperature variations, in the absence of increased humidity throughout the day, indicate that a weather station is situated in a confined area where airflow is minimal or non-existent. +- **Temperature daily median (TMD)** (%) (considering all 24-hour temperature observations) It is used to determine if a day was too cold for the sensors to freeze. The threshold below which there is a likelihood of the sensors freezing is set at 0.5°C. +- **RH standard deviation (RHSD)** (%) It has been observed that low RH variations, in the absence of increased humidity throughout the day, indicate that a weather station is situated in a confined area where airflow is minimal or non-existent. +- **RH daily median (RHMD)** (%) (considering only RH observations when solar altitude >7°) It is used to define a day as wet to assist in the investigation of parameter variance. Under wet conditions (e.g., relative humidity > 85%), temperature, relative humidity, wind, and solar irradiance may show minimal variations over time. +- **Variance of the differences of the consecutive RH observations (RHvar_diff)** (%) (considering only RH observations when solar altitude >7°) It is the variance of the differences between consecutive RH measurements. This metric is used to differentiate between ‘INDOORS’ and ‘INDOORS_ALMOST’. Weather stations that may have some potential for outdoor deployment, while most parameters suggest that they are positioned indoors, often exhibit greater fluctuations in relative humidity (RH). +- **Wind speed standard deviation (WSPDSD)** (m/s) It is a reasonable assumption that small variances in wind speed throughout the day, combined with low variances in other parameters under relatively dry conditions, may indicate a problematic deployment (dry conditions are associated with sunny days, which result in differential evaporation and heating over surfaces, eventually leading to the formation of air flows). While a weather station placed indoors should ideally show zero variations in wind speed, there may be sources of airflow (e.g., windows, cooling or heating systems) that can introduce some variation. Therefore, we establish low but not zero thresholds to filter out poorly deployed stations. +- **Wind speed constancy index** (True/False) This index is considered true when the most frequently observed wind speed occurs for more than 50% of the day. It is highly unlikely for a constant wind speed (usually at 0 m/s) to persist for half of the day. Additionally, when paired with low solar irradiance or a low RHMD (thus in relatively dry conditions), this situation suggests a criterion for poorly deployed stations. +- **Wind direction circular variance** (°) (after converting degrees into radians) We use circular variance for wind direction since it is a circular parameter. A significant lack of variance in wind direction can support the assumption that a weather station is poorly deployed. +- **Wind direction constancy index** (True/False) This index is True when the most common wind direction observation appears in more than 50% of the day. It is used similarly to Wind speed constancy index. + +### 3.2 Algorithm + +The mechanism consists of a complex if-then-else structure that was developed based on exploratory data analysis (EDA), utilizing a set of reasonable assumptions and criteria that were gradually confirmed through the EDA process. Although the algorithm is publicly available, we will present the main groups of criteria used to characterise the deployment condition of a weather station. + +The first filtering drops the stations into 3 main ‘buckets’ which are: + + a. Stations with valid data for decision-making (PSI_ON_AN > 40% and SIthe_daily_avg > 5W/m2) + b. Stations located in geographical areas (high latitudes during winter) where sunlight is insufficient throughout the day to detect any patterns and, eventually, make decisions (PSI_ON_AN > 40% and SIthe_daily_avg ≤ 5W/m2). These stations fall into the ‘ALMOST_NIGHT’ category. + c. Stations with inadequate data due to significant data loss during the day (PSI_ON_AN ≤ 40%). These stations fall into the ‘UNKNOWN’ category. + +Therefore, the first of the three aforementioned categories includes all the stations that have sufficient data and sunlight, allowing us to identify any deployment issues. Following the initial filtering, the stations that provide enough data fall into the next three categories: + + a. **CRSI_OT = 0** These stations are unable to observe any sunlight during the day, indicating that they are likely placed indoors. However, if some variation in wind speed is observed, it may suggest that the stations are located in an area with numerous significant obstacles nearby (e.g., deployed on a balcony or under a roof etc.). However, if all the other parameters variate as expected, then the light sensor may be problematic. + + b. **0% < CRSI_OT <40%** Such stations still register unexpectedly low sunlight during the day, suggesting that the station may be positioned indoors (where some sunlight might pass through windows) or could be poorly deployed (with sunlight significantly blocked by obstacles). To differentiate between an indoor station and a poorly deployed station, we utilize a series of criteria that evaluate the variability of temperature, RH, and wind. For example, a station that experiences low sunlight along with low variations in temperature, RH, and wind speed/direction, under a regime of RHMD <85%, is considered to be indoors. + + c. **CRSI_OT < 40%** This category can lead to almost any of the ISD classifications through a complex set of empirical criteria. To ensure that we focus only on the problematic cases, we utilise **RatioSIOT_daily**, specifically investigating cases with a ratio of <0.2. Additionally, we examine the variations in temperature, RH and wind to determine if a station is surrounded by significant obstacles. The variability of solar irradiance further assists in understanding whether physical variations occur throughout the day. In addition, we apply the inclination criterion (**Appendix A1**) using a threshold of <1.5 for the **RatioSIOT_daily**. + +As expected, stations with low **CRSI_OT** and/or low **RatioSIOT_daily** are classified into one of the problematic categories rather than the OUTDOORS category (**Figure 10**). + + + + **Figure 10**. Observed-to-theoretical solar irradiance ratio versus the count ratio, categorised by the five basic ISD categories. To enhance the readability of the graph, very few stations with extremely high or low count ratios and/or observed-to-theoretical solar irradiance ratios have been excluded from the presentation.. + + +### 3.3 Final Aggregator + +The ISD mechanism evaluates the previous day’s data on a daily basis and produces one result per station, per day. There are various reasons why a station’s ISD result may vary from day to day (e.g., the statistical nature of the algorithm, environmental conditions to which the station is exposed, etc.). For this reason, the ISD Aggregator takes into account the results from the last seven days to assign the final classification of each station’s deployment. + +To decide on a unique ISD annotation that determines the final Quality of Deployment (QoD) score, the ISD Aggregator considers the results of the last 7 days for each station. To determine this unique annotation, the algorithm considers the following criteria: + + a. Dominant ISD Annotation: The annotation that characterises the deployment of a meteorological station is the one that appears most frequently within the 7-day period. + + b. Tie-Breaker Criteria: If two or more annotations are equally frequent within the 7-day period, the dominant annotation is determined by its assigned weight (see **Table 1**). The weight reflects both the significance of an annotation and the algorithm’s strategy to assign greater importance to more problematic annotations (e.g., Indoors) over less problematic ones (e.g., Probably Bad Deployment). + + c. Insufficient Data: If 50.1% of the days (in this case, 4 out of 7 days) lack sufficient data, a decision cannot be made for the station. In this scenario, the dominant annotation is marked as UNKNOWN. This implies that for newly claimed stations, users must wait at least 4 days to receive an ISD annotation from the aggregator. + +Table 1. ISD Annotations, their weight of significance and their ISD score. + + + ISD Annotation + Weight + Score + + + OUTDOORS61 + INDOORS100 + ALMOST INDOORS90 + BAD DEPLOYMENT80.29 + PROBABLY BAD DEPLOYMENT70.43 + INCLINED POLE NORTH50.86 + INCLINED POLE EAST50.86 + INCLINED POLE SOUTH50.86 + INCLINED POLE WEST50.86 + PROBLEMATIC LIGHT SENSOR40.86 + REPLACE ILLUMINANCE30.86 + ALMOST NIGHT11 + INDOORS FROZEN21 + INDOORS ALMOST FROZEN21 + BAD DEPLOYMENT FROZEN21 + PROBABLY DEPLOYMENT FROZEN21 + UNKNOWN11 + +### 3.4 Final ISD Score + +The final score assigned to a station is directly related to its deployment classification from the ISD and is shown in **Table 1**. It should be noted, however, that this score is used by another algorithm (called the Unifier), which combines the scores from the individual quality mechanisms to produce the station’s final daily quality score. + +## 4. Limitations + +It's important to note that the ISD is a blind method, meaning it was developed without having many stations with known deployment status to initially validate the technique. Instead, it relied on a series of logical assumptions and criteria based on exploratory data analysis. Practical validation of ISD results is not always feasible, as deployment status can ultimately only be confirmed through photographs. However, the final version of the algorithm was evaluated on a small sample of test weather stations. Generally, there is a high degree of confidence that only problematic deployments are classified into the ISD’s problematic categories. The ISD criteria were intentionally designed to be as stringent as possible to detect exclusively problematic cases in order to avoid false positives. This strictness implies that some problematic deployments may go undetected by this mechanism. Additionally, a station can shift between categories from day to day based on weather conditions (e.g., strong winds, sunny days in winter or summer, etc.). + +Below, we outline some limitations encountered during our data analysis: + 1. **ISD mainly aims to detect “INDOORS” stations. Some poorly deployed weather stations may also be detected. However, future QoD components will be able to detect more efficiently poorly deployed stations.** + 2. Numerous poorly deployed weather stations might be classified as "OUTDOORS." This situation can result from significant fluctuations in solar irradiance due to a temporary unobstructed line of sight between the station and the sun. As a result, the light sensor may record the anticipated levels of solar irradiance and its variations for a few hours during the day. For example, this can occur even in the case of a weather station located next to an open window. + 3. Weather stations located indoors, where the user has ensured adequate sunlight and occasional airflow toward the station (such as through an open window, a fan, or an air conditioner), may be misclassified. Although it is very likely that such a station will fall into one of the problematic categories, the classification may not be accurate. + 4. Distinguishing between “PROBABLY_BAD_DEPLOYMENT” and “BAD_DEPLOYMENT” is not always an easy task. Depending on the dominant weather conditions (e.g. cloudless or dark foggy weather) a “BAD_DEPLOYMENT” weather station may fall into the “PROBABLY_BAD_DEPLOYMENT” or vice versa. + 5. Stations that fall into the categories “REPLACE_ILLUMINANCE”, “PROBLEMATIC_ILLUMINANCE”, “ALMOST_NIGHT” and “UNKNOWN” may be poorly deployed, but it is impossible to categorise them through this process. + +## Appendix + +### A1. Inclination Criterion + +This set of criteria assists in detecting tilted masts on which stations are deployed. Note that tilted masts can only be detected on completely cloudless days. To achieve this, we check the **ccOT** and **RSE** to understand the degree of similarity between observed and theoretical solar irradiance curves. In general, we search for high **ccOT** (>0.8), low **RSE (< RSEthres)** and **RHMD** <85% for the period of the day that solar altitude is >7° (to ensure that at least the lower troposphere is fairly clear). This cloudless condition is essential for detecting any inclinations of the pole. + +The process of detecting north-south tilted poles is different from this for detecting east-west tilted poles. + +To identify a north-tilted pole, we apply a straightforward criterion. The criterion is that the **RatioSIOT_daily** should be between 0.3 - 0.67 when the cloudless condition is met. This indicates that a station measures significantly lower solar irradiance than expected during a cloudless day. In contrast, a station on a south-tilted pole is characterised by **RatioSIOT_daily** between 1.05 and 1.4. This indicates that a station measures significantly higher solar irradiance than expected during a cloudless day. Ratios <0.3 are typically observed at poorly deployed stations that do not have direct exposure to sunlight, while ratios <1.4 are indicative of problems with the light sensor. + +On the other hand, to identify east/west-tilted poles, we use a more complex approach, summarised in the following steps: + + - Firstly, the **RatioSIOT_daily** should be <0.9, as SIobs can be significantly lower for extended periods during the day when the pole is tilted to the east or west. It is important to note that **SIobs** should naturally be consistently slightly lower than the **SIthe** curve on a cloudless day. + - Next, the daily time series of the solar irradiance ratio between observed and theoretical values should be divided into four segments of equal time length. + - If the **RatioSIOT_daily** of the fourth segment is >0.9 and the difference between the fourth and the first segment is >0.4, then the pole is tilted to the west. + - If the **RatioSIOT_daily** of the first segment is >0.9 and the difference between the fourth and the first segment is <0.4, then the pole is tilted to the east. + + + + **Figure 11**. Theoretical (dark red) and observed (light red) solar irradiance of cloudless days as estimated/measured by a station on a. south tilted, b. north tilted, c. west tilted and d. East tilted pole. + + +## References + +Ahmad, M. J., & Tiwari, G. N. (2011). Solar radiation models—A review. *International Journal of Energy Research, 35(4)*, 271-290. + +Järvelä, M., Lappalainen, K., & Valkealahti, S. (2020). Characteristics of the cloud enhancement phenomenon and PV power plants. *Solar Energy*, 196, 137-145. + +Nijegorodov, N. (1996). Improved ASHRAE model to predict hourly and daily solar radiation components in Botswana, Namibia, and Zimbabwe. *Renewable energy*, 9(1-4), 1270-1273. diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-annotations.md b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-annotations.md new file mode 100644 index 00000000..d4ccc322 --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-annotations.md @@ -0,0 +1,150 @@ +# OBC and SQC Annotations + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-annotations + +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) Annotations + +The QoD algorithm produces annotation codes associated with various weather parameters to provide a detailed description of a specific condition for each parameter. These codes serve as a standard format of communication between the various services that use them and they will be mapped to user-friendly messages on the clients. + +## Parameters under Investigation + +The following is a table of all parameters characterized by QoD. + +Table – Parameters considered in the analysis + + + + Parameter + Index + + + + + Temperature + 1 + + + Humidity + 2 + + + Wind speed + 3 + + + Wind direction + 4 + + + Pressure + 5 + + + Illuminance + 6 + + + Accumulated precipitation + 7 + + + +## Hourly Level Annotation + +Table – List of annotations and their definitions + + + + Annotation + Annotation code + Derives from level + Applies to + Description + Version + + + + + OBC + OBC + Raw + All parameters + Values out of bounds, related to the sensor’s spec. Faulty sensor or firmware. + 1.0.0 + + + Raw spikes + SPIKE_INST + Raw + All except precipitation and wind direction + Two consecutive values vary more than physically possible. Faulty sensor or bad deployment. + 1.0.0 + + + No median + NO_MEDIAN + Raw + All except precipitation and wind direction + Not enough data points to infer the median value of the aggregated time window. Connection issues (internet or Helium network). Useful also to identify the reason for spikes. + <=1.0.2 + + + Unidentified spikes + UNIDENTIFIED_SPIKE + Raw + All except precipitation and wind direction + Two consecutive values vary more than physically possible, but not enough data points to infer the median and identify which values are erroneous. Faulty sensor or bad deployment. + >=1.0.4 + + + N/A data + NO_DATA + Raw + All parameters + No data in the aggregated time window. Connection issues (internet or Helium network). + 1.0.0 + + + Short Constant + SHORT_CONST + Raw + All except precipitation + Value not changed in the aggregated time window, shorter than the entire reference day (e.g. a few hours). Faulty sensor or bad deployment. + 1.0.0 + + + Long Constant + LONG_CONST + Raw + All except humidity, illuminance, precipitation + Value not changed for 24 hours. Faulty sensor or bad deployment. + 1.0.0 + + + Frozen Sensor + FROZEN_SENSOR + Raw + Wind speed and wind direction + Not measuring wind speed, wind direction is constant and temperature below zero. Frozen sensor. + 1.0.0 + + + Minute Spikes + ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Two consecutive minute averages vary more than physically possible. Bad deployment (possible) / Faulty Sensor (less possible). + 1.0.0 + + + Unidentified change + UNIDENTIFIED_ANOMALOUS_CHANGE + Minute + All except precipitation and wind direction + Two consecutive values vary more than physically possible, but not enough data points to infer the median and identify which values are erroneous. Bad deployment (possible) / Faulty Sensor (less possible). + >=1.0.4 + + + +Note that there are two spike annotations. The one arises in raw level and the other in minute level. In order to distinguish between them, we refer to the raw spike annotation as SPIKE_INST and to the minute spike as ANOMALOUS_INCREASE. Thus, SPIKE_INST implies that there was an instant spike in one or more of the data packets that we received and is highly likely to be due to faulty sensor and less (but still) likely to be due to bad deployment. On the other hand, ANOMALOUS_INCREASE implies that there was suspicious change when comparing consecutive minute averages. This could be possibly due to bad deployment (e.g., gradual increase in temperature due to a chimney that started working), but we cannot exclude the case of faulty sensor. +UNIDENTIFIED_SPIKE and UNIDENTIFIED_ANOMALOUS_CHANGE label all values that appear suspicious for spikes or dips, in contrast to "SPIKE_INST" and "ANOMALOUS_INCREASE" annotations, which exclusively label the spike or dip value itself. This implies that the user will receive a different Quality of Data (QoD) score if either of the first two annotations is activated, compared to the two latter annotations. diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-documentation.md b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-documentation.md new file mode 100644 index 00000000..87cb182c --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-documentation.md @@ -0,0 +1,347 @@ +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-documentation + +# Obstacle Impact on Temperature and Wind + +Data quality serves as the mechanism used to differentiate between accurate and erroneous data recorded by a weather station. To achieve this, we employ a series of techniques and processes that scrutinise different aspects related to data quality. +The current iteration of the Data Quality algorithm incorporates control checks to pinpoint instances where a sensor records values beyond the limits specified by the manufacturer, identifies unusual jumps, recognises constant values, or determines if there is insufficient data to compute an average. + +The processes included in the Data Quality mechanism v1 are divided into two categories: +- Out-of-Bounds Check (OBC) +- Self Quality Check (SQC) + +Data Quality v1 is able to process: +- Time series with an interval <30 seconds (High Temporal Resolution Time series - **HTRT**) +- Time series with a time interval ≥1 minute (Low Temporal Resolution Time series - **LTRT**). We consider that the value provided on this time interval (e.g., 3 minutes) time interval is the outcome derived from the averaging of a sequence of internally recorded measurements. + +The **final output of the Data Quality mechanism** is an hourly **percentage** of valid/available data and the corresponding **text annotations per meteorological variable** (temperature, relative humidity, wind speed, wind direction, atmospheric pressure, illuminance and precipitation). However, there is a [post Data Quality score process](/weather-and-science/quality-mechanisms/obc-sqc-score-calculation) that aggregates all the annotations and scores into a daily output per station. + +Before moving forward to the description of the Data Quality mechanism, we should note that the input data has been standardised over time (resampling). Weather stations may transmit data at varying non-fixed time intervals. This implies that even if a station's specification indicates a recording frequency of 16 seconds, the actual interval can fluctuate, ranging from a few seconds to several minutes. To ensure that the quality control operates on a time-normalised dataset, a new timeframe is established with a fixed interval (determined by the theoretical recording frequency (fr) of the station model, such as 16’’ for the WG1000 - M5 model). + +## 1. Filling Ignoring period - Filling No-Data Slots + +To ensure the proper functioning of certain SQC processes, an ignoring time period is established (**Table 1**). In practice, all time slots within the ignoring period that lack data are filled with the most recent valid value. Subsequently, this newly filled time series is exclusively employed for scrutinising constant data and anomalous jumps at the raw scale level (see **section 3**). + +***Table 1** – Ignoring period for the available weather station models.* +| Weather Station Model | Ignoring Period [seconds] | +|:---------------------:|:-------------------------:| +| WG1000 (M5) | 60 | +| WS2000 (Helium) | 180 | + +## 2. Out-of-Bounds Check (OBC) + +OBC is a simple process aimed at identifying values for each parameter that exceed the limits set by the manufacturer. The OBC proves highly valuable in identifying sensors that might be experiencing technical malfunctions. OBC is a simple check for temperature, relative humidity, wind speed/direction, atmospheric pressure, illuminance and precipitation that stands alone. + +Particularly for the parameter of precipitation, OBC applies to the variable “accumulated precipitation”. As OBC for precipitation looks at the accumulated precipitation difference between two consecutive time steps, it should be applied over the filled time series produced in **section 1**. This allows for a discrimination of faulty precipitation rates, even under the lack of data for a predefined short period of time. The upper cut-off limit used for this process is time dependent, as its default unit is in mm/sec. Thus, this limit is adjusted depending on the recording frequency of the station model (e.g., from 0.254mm/sec to 4.064mm/16sec) and, eventually, the OBC is applied on the difference of the “accumulated precipitation”. In case of a no-data slot that has been filled (according to the process in **section 1**), the precipitation cut-off threshold is reduced to the corresponding time (e.g., for a data temporal resolution of 16’’, if time slots at 16’’, 32’’ and 48’’ have no data and have been filled with the value of the latest valid measurement at 00’’, and the next available measurement is at 64’’, the cut-off limit will gradually increase for each filled time step till the next valid datum, such as 4.064, 8.128, 12.192, 16.256mm). + +Currently, there are two sets of outdoor sensors (WS1000 and WS2000), each accompanied by its own respective specifications outlined in **Tables 2 and 3**. + +***Table 2** - Manufacturer’s limits for WS1000 (M5) sensors.* +| Parameter | Lower Limit | Upper Limit | +|:------------------------:|:-----------:|:-----------:| +| Temperature [°C] | -40 | 60 | +| Relative Humidity [%] | 10 | 99 | +| Wind Direction [°] | 0 | 359 | +| Wind Speed [m/s] | 0 | 50 | +| Atmospheric Pressure [mb]| 300 | 1100 | +| Illuminance [Lux] | 0 | 400000 | +| Precipitation [mm] | 0 | 0.254/sec | + +***Table 3** - Manufacturer’s limits for WS2000 (Helium) sensors.* +| Parameter | Lower Limit | Upper Limit | +|:-------------------------:|:-----------:|:-----------:| +| Temperature [°C] | -40 | 80 | +| Relative Humidity [%] | 1 | 99 | +| Wind Direction [°] | 0 | 359 | +| Wind Speed [m/s] | 0 | 50 | +| Atmospheric Pressure [mb] | 540 | 1100 | +| Illuminance [Lux] | 0 | 200000 | +| Precipitation [mm] | 0 | 0.254/sec | + +## 3. Self Quality Check (SQC) + +SQC is a process that aims to detect anomalous behaviour of weather observations due to faulty sensors or not proper deployments using only the data of a single weather station itself. The thresholds, but also the assumptions that lead to the final result, are based on the ([WMO](https://library.wmo.int/viewer/35699/?offset=#page=214&viewer=picture&o=search&n=0&q=suspicious)) and ([European Commission](https://publications.jrc.ec.europa.eu/repository/handle/JRC128152)) general guidelines. However, our further data analysis based on data from the WeatherXM network results in corrected and less strict thresholds at some SQC checks. + +As there are weather stations that transmit data at various time intervals, ranging from a few seconds to several minutes, SQC should be capable of annotating data regardless of the temporal resolution of a data time series. However, it is important to highlight that temporal resolutions exceeding 1’ may not be suitable for achieving rigorous control checks. + +SQC consists of a series of controls per parameter (temperature, relative humidity, wind speed, wind direction, atmospheric pressure and illuminance) at different time scales, which differ for different temporal resolutions (HTRT, LTRT). Note that precipitation is excluded from SQC, as it requires a careful and more complex quality control. + +A HTRT passes through (**Table 4**): +a. raw scale level control (every single of the raw data is checked for suspicious jumps, unavailable and constant data), +b. minute scale level control (1-minute averaged data are checked for suspicious jumps and unavailable data) +c. hourly scale level control (final counting of invalid/unavailable hourly time slots) + +For LTRT, practically only the raw (which is now called inter-minute scale level) and the hourly scale levels are applied, as the minute averaging is not applicable (**Table 5**). + +*Table 4 - All the control processes that extend across the three time scale levels for the case of a weather station that records data every 30 seconds or less (e.g., WG1000 (M5)).* +| Control Process of HTRTs (<30 sec) | Time Scale | Control Check Type | +|:---------------------------------:|:------------:|:-------------------------------------------:| +| Raw Scale | <30 sec | Constant data detection
Unavailable data detection | +| Minute Scale | 1 minute | Suspicious Jump Detection
Unavailable data detection | +| Hourly Scale | 1 hour | Suspicious Jump Detection
Counting of invalid hourly time slots | + +*Table 5 - All the control processes that extend across the two time scale levels for the case of a weather station that records data every 1 minute or more (e.g., WS2000 (Helium)).* +| Control Process of LTRTs (≥1 min) | Time Scale | Control Check Type | +|:--------------------------------:|:-----------------:|:-------------------------------------------:| +| Inter-Minute Scale | ≥1 min | Constant data detection
Unavailable data detection | +| Hourly Scale | 1 hour | Suspicious Jump Detection
Counting of invalid hourly time slots | + +There are three basic processes to check **Constancy**, **Availability** and **Fluctuation** of the data, these are **a. Constant data detection, b. Unavailable data detection and c. Suspicious jump detection**. + +### a.Constancy Checks +The constant data detection process aims to identify whether a sensor is recording unchanging values due to technical disruptions or improper deployment. This process is applied to raw data to ensure that even insignificant alterations over a span of a few seconds are taken into account. According to WMO recommendations, the parameters of temperature, relative humidity, wind speed, wind direction and atmospheric pressure should not remain constant for more than 1 hour. However, our current approach employs a more flexible strategy, employing different thresholds according to our data analysis ([see the report](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)). +While constant data typically raises suspicion, there are certain cases that warrant exclusion. For instance, during foggy or fairly wet conditions, there is often a prolonged period of constant relative humidity/temperature/wind spanning hours, and thus, such cases are excluded from this process (**Table 6** - Constancy Duration Threshold). Regarding wind speed, constant, but non-zero wind speed under freezing temperatures is considered as faulty (due to faulty sensor). Note that in the particular case of WS2000, constant annotations on wind speed measurements are removed if wind direction comes with no constant annotations (this applies to all types of constant annotations). Regarding illuminance, we establish a maximum threshold for constant illuminance when it is not equal to 0 lux. This is because it may remain at ≠0Lux for extended hours during the night, but it should not remain constant at a specific value for an extended period during the day. +Finally, a second set of constancy checks is established to mainly identify faulty sensors (**Table 6** - Constancy Duration Max Threshold). Consequently, any time series under investigation is marked as erroneous when the data remain constant for 1440 minutes without any additional specific conditions. It is worth noting that relative humidity has been excluded from this criterion due to its potential to remain constant for longer durations (as explained in [the report](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx)). In addition, illuminance and pressure are also excluded since the initial set of criteria (with a 120-minute threshold) adequately addresses constancy checks for this parameter. + +Table 6 - Duration thresholds for the constant data detection process. + + + + Variable + Constancy Duration Threshold (minutes) + Constancy Duration Max Threshold (minutes) + Control Checks (annotated as faulty) + Exclusions + + + + + Temperature + 240 + 1440 + Constant values when RHmedian < 95%
Constant values when RHmedian ≥ 95% + – + + + Relative Humidity + 360 + – + Constant values when RHmedian < 95%
Constant values when RHmedian ≥ 95% + – + + + Wind Speed + 360 + 1440 + + Constant wind speed = 0 m/s when Tmedian > 0°C
+ Constant values when Tmedian < 0°C (frozen)
+ Constant wind speed = 0 m/s when RHmedian < 85%
+ Constant wind speed ≠ 0 m/s
+ Constant values when RHmedian ≥ 85% + + – + + + Wind Direction + 360 + 1440 + + Constant wind direction when Tmedian > 0°C
+ Constant wind direction when RHmedian < 85%
+ Constant values when Tmedian ≤ 0°C
+ Constant values when RHmedian ≥ 85% + + – + + + Atmospheric Pressure + 120 + – + Constant pressure regardless of the pressure value + – + + + Illuminance + 120 + – + Constant illuminance when ≠ 0 Lux
Constant illuminance when = 0 Lux + – + + + +### b. Unavailable Data Detection + +Having already resampled the timeframe, we then check for no-data timeslots. We count the no-data time slots at both raw and minute scale levels. Note that in minute scale level, a no-data timeslot may arise due to lack of raw data within a certain minute or invalidity of data (e.g., see **section 3c**). + +In order to be able to produce 1-10min averages (as [WMO](https://library.wmo.int/viewer/35699/?offset=#page=213&viewer=picture&o=search&n=0&q=suspicious) recommends), one valid (which has passed all the previous control checks) data package per minute and one per 3 minutes is required for HTRTs and LTRTs respectively (**Table 7**). Note that in both cases a data package is the result of averaging measurements within that period of time (which coincides with the uplink rate of each weather station e.g., 16’’ and 3’ for WS1000 and WS2000). However, in cases of weather stations at remote places with difficulties in connection and power, even a single data package per hour is still valuable (e.g., comparing with numerical model outputs) and should be scored by the Data Quality mechanism. Finally, no-data slots are counted in the Minute/Inter-Minute level (HTRTs/LTRTs) and the hourly result eventually contributes to the final Data Quality score. + +Table 7 - Maximum and minimum expected (with no penalty) number of data packages per weather station type. + + + + Station Type + Maximum No of Data Packages per Hour + Minimum No of Data Packages with no Penalty + + + + + WS1000 + 225 + 60 (1/minute) + + + WS2000 + 20 + 18 (~1/3minutes) + + + +To generate 1-10 minute averages, a valid data package is required for each minute (for HTRTs) and one every three minutes (for LTRTs). A data package, resulting from averaged measurements within the specified time period, aligns with the uplink rate of each weather station, such as 16’’ and 3’ for WS1000 and WS2000, respectively. It's important to note that, in instances where weather stations face challenges in connectivity and power (e.g., stations on mountain tops), even a single data package per hour holds value (e.g., for comparison with numerical model outputs) and should be assessed by the Data Quality mechanism. Additionally, no-data slots are considered at the Minute/Inter-Minute level (HTRTs/LTRTs), and the hourly outcome ultimately contributes to the final Data Quality score. + +### c. Suspicious Jump Detection + +Suspicious jump detection is employed to detect abrupt and unusual changes in a parameter occurring within a short period of time. Such changes are often attributed to technical disruptions, although in fewer instances, they may result from improper deployment. This process is applied along both raw and minute scale levels for HTRTs (**Table 8**), while it operates solely at the raw data scale for LTRTs (**Table 9**). The LTRTs’ thresholds are applied in a proportional way till the pre-defined upper limit (**Table 9**). For instance, if the temperature jump threshold for a 1-min interval is 3°C, it will be 9°C for a 3-min interval, but will never exceed the upper limit of 15°C. The upper limits are recommended by the European Commission for consecutive 1-hour averaged values. We highlight the lack of RH upper limit prompting us to make an arbitrary yet logical decision to set the value at 80%. In case of a faulty jump detection, an additional check is conducted to label the subsequent value as faulty if it equals the previously identified faulty value. + +To overcome the challenge of distinguishing a faulty value from two consecutive ones, we require a minimum of 67% of the data within the past 10-minute window to calculate the median for HTRTs (60-min window for LTRTs). Subsequently, we compare both the two consecutive values with the calculated median, eventually categorising the one with the largest absolute difference from the median as faulty. The same process applies on both raw and (inter-minute) scale levels. Note that if the median cannot be calculated, then no decision can be taken and the datum is annotated as not available. + +Table 8 - Jump thresholds for the raw and minute scale levels for HTRTs. There are no jump thresholds for wind direction observations. + + + + + Temperature + RH + Wind Spd + Wind Dir + Pressure + Illuminance + + + + + Raw scale level jump threshold + ≤2°C + ≤5% + ≤20m/s + - + ≤0.5mb + ≤97600Lux + + + Minute scale level jump threshold + ≤3°C + ≤10% + ≤10m/s + - + ≤0.8mb + ≤97600Lux + + + +Table 9 - Jump thresholds for the raw and minute scale levels for LTRTs. There are no jump thresholds for wind direction observations. + + + + + Temperature + RH + Wind Speed + Wind Dir + Pressure + Illuminance + + + + + Inter-Minute scale level jump threshold + ≤3°C + ≤10% + ≤10m/s + - + ≤0.8mb + ≤97600Lux + + + Upper Limit + 15°C + 80% + 15m/s + - + 15mb + 146400Lux + + + +### d. Interpreting the Annotations + +At both of the raw and (inter-) minute scale levels various text annotations are assigned to every single value for each of the 7 investigated meteorological variables (**Table 10**). At the hourly scale level, all the unique text annotations produced in the previous levels are gathered to provide information about all the detected faults within the hourly slot. + +Detailed description of the derived annotations can be found here. + +Table 10 - All the possible annotations derived from Data Quality v1 and reach the hourly/daily level. + + + + Annotation Code + Derivation level + Applies to + Process + Description + + + + + 1
OBC + Raw + All parameters + OBC + Value is out of manufacturer’s bounds + + + 2
SPIKE_INST + Raw + All except precipitation and wind direction + Suspicious Jump Detection + Value represents a meteorologically unreasonable spike/dip + + + 3
UNIDENTIFIED SPIKE + Raw + All except precipitation and wind direction + Suspicious Jump Detection + Group of consecutive values with large difference, but not enough data to identify the true spike + + + 4
NO_DATA + Raw + All parameters + Unavailable Data Detection + No data received in the expected timeslot + + + 5
SHORT_CONST + Raw + All except precipitation + Constancy Checks + Parameter remains constant for longer than expected + + + 6
LONG_CONST + Raw + All except humidity, illuminance, precipitation + Constancy Checks + Parameter remains constant for longer than expected + + + 7
FROZEN_SENSOR + Raw + Wind speed and wind direction + Constancy Checks + Parameter remains constant for longer than expected due to low temperatures + + + 8
ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Suspicious Jump Detection + Value represents a meteorologically unreasonable spike/dip + + + 9
UNIDENTIFIED_ANOMALOUS_INCREASE + Minute + All except precipitation and wind direction + Suspicious Jump Detection + Group of consecutive values with large difference, but not enough data to identify the true spike diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.md b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.md new file mode 100644 index 00000000..75c76515 --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/obc-sqc-score-calculation.md @@ -0,0 +1,40 @@ +# OBC and SQC Score Calculation + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/obc-sqc-score-calculation + +# Out-of-Bounds (OBC) and Self Quality Checks (SQC) Score Calculation + +QoD v1.0.0 includes three control processes: + a. OBC (Out-of-Bounds Check) + b. SQC (Self-Quality Check) + +The OBC and SQC processes produce hourly scores per weather station, which range between 0-1 depending on the availability of the clear (valid and available) data. Here, we describe the method of converting hourly scores per parameter to a daily score per weather station. + +The Out-of-Bounds (OBC) and Self-Quality Checks (SQC) are the two basic processes that run together to finally: + a. annotate weather data in hourly level depending on their quality, + b. produce a unique daily score and annotations per weather station + +Internally, the OBC and SQC processes look into each of the 7 meteorological parameters (temperature, relative humidity, wind speed, wind direction, pressure, illuminance and precipitation). Precipitation passes only through the OBC process, as it needs more complex techniques to detect faults in such measurements. + +At the end of the OBC/SQC processes, considering that we always check a 24-hour period of data, each meteorological parameter comes with 24 hourly scores (Shourly), which arise from the availability of the clear (valid and available) data and range between 0-1. + +The way from Shourly per parameter to a total daily score (Stotal) per station is described in the following steps: + +Firstly, we calculate the **daily score per parameter** (Sdaily parameter): + +$$ +S_{\text{daily parameter}_{i}} = 1/24 \sum_{j=1}^{24} S_{\text{hourly}_{i,j}} +$$ + +Where: + i has range 1 to 7, as the number of the, under examination, meteorological parameters + j is the hour ranging between 1-24 (or 0-23) + +Finally, the **total daily score** (Stotal) is calculated as follows: + +$$ +S_{\text{total}} = \frac{1}{n} \sum_{i=\text{obc-sqc - 1}}^{n} S_{\text{daily parameter}_{i}} +$$ + +Where: + n is the number of meteorological parameters (for now n=7) diff --git a/static/llms-pages/weather-and-science/quality-mechanisms/spv-full-documentation.md b/static/llms-pages/weather-and-science/quality-mechanisms/spv-full-documentation.md new file mode 100644 index 00000000..3e78395f --- /dev/null +++ b/static/llms-pages/weather-and-science/quality-mechanisms/spv-full-documentation.md @@ -0,0 +1,528 @@ +# Station Photo Verification (SPV) + +Canonical: https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation + +#Station Photo Verification (SPV) Full Documentation + +At WeatherXM, we aim to ensure that all station installations in our network follow, as closely as possible, the guidelines set by the World Meteorological Organization (WMO). This alignment ensures that the data generated by our stations is reliable and can be effectively used across the various use cases our company supports. + +The SPV mechanism serves a dual purpose, just like all quality control processes related to data and deployments at WeatherXM: + a. To document the deployment so that anyone interested in the station’s data knows whether it can be trusted, and + b. To inform the user about the quality of the deployment, with the goal of encouraging and motivating them to improve it as much as possible. + +## 1. The SPV Aspects + +To ensure the process is as objective as possible, we have defined seven distinct annotation categories (hereafter referred to as SPV aspects). One aspect assesses the validity of the photo, four aspects evaluate the potential impact of the deployment on specific sensors, and two additional aspects describe the mast’s properties. + +As mentioned earlier, there are seven SPV aspects to annotate for every single photo of a given station deployment. Since we expect four photos per deployment, one for each of the four points of the horizon (N, E, S, W), each of the seven SPV aspects should be annotated for every photo. This multi-aspect scoring approach allows us to more effectively identify which sensors may be affected by a faulty deployment and to highlight these impacts. + +The SPV aspects, which are shown together with their annotations and scores in **Table 1**, are: + 1. Photo Validity + 2. Mast Height + 3. Mast Inclination + 4. Temperature and RH + 5. Wind + 6. Precipitation + 7. Solar Irradiance + +Note that: + a. Mast height and mast inclination are the 2 aspects that are not scored. + b. Temperature, relative humidity (RH), wind, precipitation, and solar irradiance are the 4 aspects related to the corresponding sensors referred to as **SPV sensor aspects**. + +In addition to the aspects, the reviewer is able to leave comments regarding potential issues that have not been anticipated by the predefined annotation system, as well as suggestions on how the user could improve their deployment. + +Table 1. All the SPV aspects together with their possible annotations (per aspect) and their corresponding scores. + + + + SPV Aspect + Annotations + Score + + + + + photo_validity + valid + 1 + + + partly_valid + 0.5 + + + invalid + 0 + + + mast_height + over + - + + + proper + - + + + mid + - + + + low + - + + + mast_inclination + inclined + - + + + not_inclined + - + + + t_rh + valid + 1 + + + partly_affected + 0.5 + + + biased + 0 + + + wind + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + precipitation + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + solar_irradiance + no_obstacles + 1 + + + small_obstacles + 0.5 + + + significant_obstacles + 0 + + + +## 2. The Scoring Process +Once each SPV aspect has been uniquely annotated for each of the 4 photos of the deployment (each for every single point of horizon -N, E, S, W-), the following calculations can be performed to determine the final score for each deployment: + a. Average the scores of the SPV sensor aspects per photo (thus per point of horizon) to get the spv_sensor_average_per_horizon_point + b. Multiply each spv_sensor_average_per_horizon_point by the corresponding photo validity score (per point of horizon) to obtain spv_fnl_per_horizon_point. + c. Average all the elements in spv_fnl_per_horizon_point to obtain the final SPV score of the deployment (spv_total_deployment_score) + +Note that each of the four photos should be annotated for all SPV aspects. However, if the photo_validity aspect is marked as invalid, scoring the remaining SPV aspects is of little significance, since marking a photo as invalid automatically sets its score to zero. + +The following Python script demonstrates how these calculations can be performed: + +```python +import numpy as np +# Each list contains the scores per photo in the order +# [North, East, South, West] + +# Define the photo validity aspect +photo_validity_aspect = np.array([1,1,1,0]) + +# Define a dictionary with all the SPV sensor aspects +spv_sensor_aspects = { + "temperature": np.array([1,1,1,0]), + "rh": np.array([1,1,0.5,0]), + "wind": np.array([1,0.5,0.5,0]), + "precipitation": np.array([1,0.5,0.5,0]), + "solar_irradiance": np.array([np.nan,0,0,0]) +} + +# Get the average between the SPV sensor aspects per index (index = point of horizon) +values_matrix = np.column_stack(list(spv_sensor_aspects.values())) +spv_sensor_average_per_horizon_point = np.nanmean(values_matrix, axis=1) + +# Multiply each horizon point average with the validity score of the photo of the horizon point +spv_fnl_per_horizon_point = photo_validity_aspect * spv_sensor_average_per_horizon_point + +# Averaging the the elements of the spv_fnl_per_horizon_point +spv_total_deployment_score = np.nanmean(spv_fnl_per_horizon_point) +``` + +## 3. General Deployment Guidelines + +To successfully pass all SPV checkpoints, a user must ensure the following: + +**A. Photo Validity** +- Upload four valid landscape-mode photos (one per cardinal direction: North, East, West, South). Note that the eight aspects are evaluated for each cardinal direction separately. +- The station must be visible and centred in each photo. +- Photos should be taken at the station’s level, or (if not possible) from far enough away to capture all nearby features (e.g., trees or buildings, including those behind the station). +- Photos should be taken after installation and show all parts of the station clearly, along with the widest possible view of the surroundings in the direction faced. +- Avoid using portrait mode or zoomed-in images. +- In case taking a photo at a certain point of the horizon is not possible (e.g., because the station is located at the edge of a tall building), it is recommended to use a selfie stick or to take a photo that shows the specific point of the horizon but includes at least part of the mast (if it is only one horizon point that cannot be captured) or part of the station (if more than one horizon points cannot be captured), so that the orientation can be determined. In any case, photos taken in this way must not exceed two. + +**B. Mast Height** +- The station must be mounted on a pole that is at least 2 meters tall. +- It must also be positioned at least 2 meters above any surface below or beside it. +- Ideally, the station should not be shaded by obstacles during the day and should be fully exposed to direct sunlight. + +**C. Mast Inclination** +- The pole must be visibly vertically aligned with respect to sea level. +- The alignment bubble on the station should be used during installation to ensure proper levelling. + +**D. Obstacle Distances per Parameter** +- The station should be located at a distance at least twice the vertical difference between the station and the height of surrounding obstacles to accurately measure temperature and relative humidity. +- The station should be at a distance at least seven times the height difference from surrounding obstacles to accurately measure wind. +- The station should be at a distance at least four times the height difference from surrounding obstacles to accurately measure precipitation. + +**E. Solar Radiation** +- The station should not be shaded during daylight hours by obstacles such as trees, buildings, or antennas. +- There must be direct line-of-sight between the sun and the solar radiation sensor. + +## 4. Practical Examples of Station Evaluation + +### The Perfect Deployment + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------|-------------------------|-------------------------|-------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Proper | Proper | Proper | Proper | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Orientation | North | West | East | South | +| | | | | | + +The weather station is ideally installed. These are the key points: +- It is deployed in an open area, with surrounding obstacles (e.g., buildings) located at a distance at least two/four/seven times the difference in height between the obstacle and the station. This setup eliminates any potential impact on temperature/precipitation/wind measurements +- It is mounted on mast height is appropriate (2–4 meters). +- The user has uploaded one photo per cardinal direction, each providing a wide view of the surrounding environment. + +### Partly Valid Photos and Short Mast + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|----------------------------|-------------------------|----------------------------|-------------------------| +| Photo Validity | Partly Valid (0.5/1) | Invalid (0/1) | Partly Valid (0.5/1) | (0/1) | +| Mast Height | Low | - | Low | - | +| Mast Inclination | Not Inclined | - | Not Inclined | - | +| Temperature and RH | Biased (0/1) | - | Biased (0/1) | - | +| Wind | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | - | +| Precipitation | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | - | +| Solar Irradiance | No Obstacles (1/1) | - | No Obstacles (1/1) | - | +| Orientation | North | - | West | - | +| | | | | - | + +There are multiple issues in this SPV photo set: +- The station is mounted on a very short mast, positioning it close to the roof surface. This setup significantly affects temperature readings due to heat emitted by the concrete, leading to an overestimation of daytime temperatures. Additionally, placing the station so close to a surface usually results in underestimated wind speeds, as surface friction slows down the airflow. +- The round-shaped antenna above the station may obstruct raindrops from entering the rain gauge, potentially impacting precipitation measurements. +- The user has uploaded two photos showing the northern and western cardinal directions. These are only partially valid: in the first photo (north), the area behind the wall is not visible. In the second photo (west), half of the horizon is obscured by the wall. As a result, we cannot confirm whether additional obstacles may exist that could affect the measurements. +- A third photo, which also shows part of the northern horizon, is practically unusable and is therefore marked as invalid. +- Finally, there are no photos showing the eastern and southern directions, meaning these two cardinal points will be graded with a score of 0. + +### Short Mast, Chimney and Obstacles + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Mid | Mid | Mid | Mid | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | Significant Obstacles (0/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | Small Obstacles (0.5/1) | +| Precipitation | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | Small Obstacles (0.5/1) | +| Orientation | North | West | East | South | +| | | | | | + +This is an apparently satisfactory deployment. And it should be noted that, although the photos are in portrait mode, they adequately capture the surrounding area. However, there is a series of issues, which are: +- The station is mounted on a mast that provides approximately 1 meter distance from the roof. However, the mast is installed on top of a chimney, which, along with the limited distance, can introduce errors in temperature, humidity, and wind measurements under certain conditions. +- The trees located to the north, south, and especially the east are particularly tall and relatively close to the station. This setup can significantly affect wind measurements, as well as precipitation readings when rain is accompanied by wind from those directions. It may also interfere with solar radiation measurements due to shading. + +### Insufficient Number of Photos and Short Mast + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid | (0/1) | (0/1) | +| Mast Height | Low | Low | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Biased (0/1) | Biased (0/1) | - | - | +| Wind | Small Obstacles (0.5/1) | No Obstacles (1/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Small Obstacles (0.5/1) | No Obstacles (1/1) | - | - | +| Orientation | West | East | - | - | +| | | | - | - | + +This particular station appears to fail to meet several of the SPV mechanism’s criteria: +- The station is mounted on a short mast over a black surface. The temperature measurements, especially during the day, are significantly affected. At the same time, the airflow may be influenced by the building on which the station is mounted +- There are also trees nearby that may affect both the airflow and block sunlight from reaching the solar radiation sensor. +- Although, in the photo depicting the eastern horizon, the problem with airflow still exists, since the horizon is generally open without obstacles, we give the user a small boost by scoring the wind aspect for this point of the horizon with a 1. +- The photos do not depict the entire western and eastern horizons, but they are sufficient to give us a clear picture of the surrounding area. However, there are no photos depicting the northern and southern horizons, which prevents the user from achieving a better score. + +### Missing Rain Gauge Cup and Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | (0/1) | (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | - | - | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Significant Obstacles (0/1) | Significant Obstacles (0/1) | - | - | +| Orientation | East | South | - | - | +| | | | - | - | + +This appears to be a correctly installed weather station. However, there are two critical points that prevent it from receiving an excellent score: +- The absence of photos depicting the remaining points of the horizon (north and west). +- The black cap of the rain gauge is missing, resulting in it recording almost no measurements. + +### Missing Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Valid (1/1) | Valid (1/1) | (0/1) | +| Mast Height | Proper | Proper | Proper | - | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | - | +| Wind | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| | | | | - | + +This station could have received the maximum score, but once again, it is the details that prevent the user from achieving a perfect rating: +- The three photos show almost a 180° range around the station. Although the photo depicting the south actually shows only part of it, it can be concluded that the horizon is clear of obstacles. This is not the case in the photo showing the northern horizon, where some nearby trees are visible. Ideally, we would want a photo covering the north. +- There is no photo showing the west at all. There could be a large tree or wall significantly affecting the station’s measurements. Although the station appears to be installed quite correctly, the inadequate depiction of the surrounding environment prevents the user from obtaining the maximum SPV score. + +### Missing Weather Station from Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|--------------------|--------------------|--------------------|--------------------| +| Photo Validity | Invalid (0/1) | Invalid (0/1) | Invalid (0/1) | (0/1) | +| Mast Height | - | - | - | - | +| Mast Inclination | - | - | - | - | +| Temperature and RH | - | - | - | - | +| Wind | - | - | - | - | +| Precipitation | - | - | - | - | +| Solar Irradiance | - | - | - | - | +| Orientation | - | - | - | - | +| | | | | - | + +This may be the perfect installation. However: +- The station is not visible in any of the photos. This means that we do not know which point of the horizon each photo depicts, the exact location and height of the station, or whether the location shown is indeed that of the station. +- In any case, we need four photos, one for each point of the horizon. + +### Short Mast and Missing Photos + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Partly Valid (0.5/1) | - (0/1) | - (0/1) | +| Mast Height | Low | Low | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Biased (0/1) | Biased (0/1) | - | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Orientation | West | South | - | - | +| | | | - | - | + +Rooftops are among the best places to install a station in urban environments; however, all basic installation requirements must be met. In this particular case: +- The station is mounted on a very short mast in front of a ledge. This means it is heavily affected by heat from the concrete surfaces, while its proximity to the floor and the ledge increases surface roughness, slowing down or even altering the direction of airflow. +- There are no photos for all points of the horizon, which does not allow the reviewer to fully assess the station’s surrounding environment. +- This appears to be a potentially excellent installation site, but due to carelessness, the station misses out on a perfect score. + +### Two Photos - Two Aspects + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 |-------------------| +|----------------------|-------------------------------|----------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Partly Affected (0.5) | Biased (0/1) | - | - | +| Wind | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Precipitation | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | Significant Obstacles (0/1) | - | - | +| Orientation | West | East | - | - | +| | | | - | - | + +This station is installed in a poor location, and not all the photos are informative: + +- One photo shows an open horizon without obstacles; however, a roof appears at the top of the image, which may “shield” the station under certain conditions. +- The other photo confirms what we suspected from the first one. There is a canopy almost directly above the station, a wall very close by, and to the right, a fairly tall building at a short distance. Here, the walls will add extra heat, causing erroneous temperature measurements, while in combination with the roof, the airflow is blocked from multiple directions, making the wind measurements completely unreliable. + +### Station within Backyards + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | Proper | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Partly Affected (0.5) | Partly Affected (0.5) | - | - | +| Wind | Significant Obstacles (0/1) | Small Obstacles (0.5) | - | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Solar Irradiance | Small Obstacles (0.5) | No Obstacles (1/1) | - | - | +| Orientation | West | North | - | - | +| | | | - | - | + +This station is located between buildings and their courtyards, which creates various problems: + +Large trees create wind shade, while the air can be funnelled between the buildings, causing the station to record a completely different wind direction and speed from the prevailing conditions in the area. +- Because the airflow can be significantly obstructed, the temperature of the air around the station differs from that of the free-flowing air. It may also be affected by the presence of nearby buildings. +- Here as well, photos for all points of the horizon are not available. + +### The Underrated Weather Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------|-------------------|-------------------| +| Photo Validity | Partly Valid (0.5/1) | Invalid (0/1) | - (0/1) | - (0/1) | +| Mast Height | Proper | - | - | - | +| Mast Inclination | Not Inclined | - | - | - | +| Temperature and RH | Valid | - | - | - | +| Wind | No Obstacles (1/1) | - | - | - | +| Precipitation | No Obstacles (1/1) | - | - | - | +| Solar Irradiance | No Obstacles (1/1) | - | - | - | +| Orientation | West | - | - | - | +| | | | - | - | + +This is probably an underrated station because: +- The user did not upload one photo for each point of the horizon. +- The photo showing the north is quite zoomed in, making it impossible to see the surrounding area. +- However, the single valid photo shows a potentially well-positioned station, but the photos needed to confirm this are missing. + +### A Rough Installation + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|--------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Invalid (0/1) | Valid (1/1) | Valid (1/1) | Partly Valid (0.5/1) | +| Mast Height | - | Mid | Mid | Mid | +| Mast Inclination | - | Inclined | Inclined | Inclined | +| Temperature and RH | - | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | - | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | - | No Obstacles (1/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | +| Solar Irradiance | - | No Obstacles (1/1) | No Obstacles (1/1) | Significant Obstacles (0/1) | +| Orientation | - | North | East | West | +| | | | | | + +This station is located in an interesting area but installed in a very hasty manner: +- Two photos show the same point of the horizon. +- In the other photos, the mast appears to be tilted. However, the main reason the solar radiation measurements are invalid is that the station is positioned lower than the tops of the surrounding trees, which shade it. +- The nearby trees certainly cause wind shading, and in particular, the tree to the west is so close that rainfall may not be recorded correctly when the wind is from the west. The mast is poorly fixed and may wobble, preventing reliable wind measurements. +- The station is poorly secured and quite low, meaning the temperature may be significantly influenced by the ground. + +### A Chimney Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Invalid (0/1) | Valid (1/1) | Partly Valid (0.5/1) | +| Mast Height | Mid | - | Mid | Mid | +| Mast Inclination | Not Inclined | - | Not Inclined | Not Inclined | +| Temperature and RH | Partly Affected (0.5/1) | - | Partly Affected (0.5/1) | Partly Affected (0.5/1) | +| Wind | Small Obstacles (0.5/1) | - | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | No Obstacles (1/1) | - | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | No Obstacles (1/1) | - | No Obstacles (1/1) | No Obstacles (1/1) | +| Orientation | South | - | West | North | +| | | | | | + +This station could have been among the excellent ones, but there are reasons why this is not the case: +- The station is very close to a chimney, which means that when the chimney is active, the temperature readings will be incorrect. The chimney may be permanently inactive, but this is something the reviewer cannot know. +- In addition, the station is very close to the chimney wall, which can cause various turbulent flows that may prevent accurate wind measurement. + +### The "Hidden" Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Partly Valid (0.5/1) | Partly Valid (0.5/1) | Partly Valid (0.5/1) | Partly Valid (0.5/1) | +| Mast Height | Low | Low | Low | Low | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Biased (0/1) | Biased (0/1) | Biased (0/1) | Biased (0/1) | +| Wind | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles | +| Precipitation | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles | +| Solar Irradiance | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | Significant Obstacles (0/1) | +| Orientation | East | North | South | West | +| | | | | | + +This station is clearly tucked inside a forest, placed on the balcony of a house, and this creates multiple problems: +- With many walls around it, the air cannot circulate freely, and some of these walls may heat up during the day, warming the adjacent air. +- The surrounding vegetation is dense, and in practice, the wind blowing in the area has little to do with what the station measures. At the same time, the tree canopy prevents a significant portion of precipitation from reaching the rain gauge. +- The dense vegetation also prevents accurate measurement of solar radiation. + +### The perfectly Imperfect + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | - (0/1) | - (0/1) | +| Mast Height | Over | Over | - | - | +| Mast Inclination | Not Inclined | Not Inclined | - | - | +| Temperature and RH | Valid (1/1) | Valid (1/1) | - | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | - | +| Precipitation | Significant Obstacles (0/1) | Significant Obstacles (0/1) | - | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | - | - | +| Orientation | North | West | - | - | +| | | | - | - | + +This station is installed at a very high position, which is recorded by the SPV tool and is one of the station’s strong positives. However, mounting it on a pillar can be problematic: +- The pillar may block part of the precipitation when the wind blows from certain directions. +- Clearly, wind coming from the direction of the pillar will be underestimated, and its direction may not be accurately recorded. +- From the photos, it is unclear whether the pillar blocks solar radiation at sunrise, so it was not rated negatively for this. +- Here too, the four photos ,one for each point of the horizon, are missing. It is understandable that taking such photos might be difficult, but some could be taken from ground level, always including both the station and the surrounding area. + +### The Fence Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Mast Height | Proper | Proper | Proper | Proper | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | Not Inclined | +| Temperature and RH | Valid (1/1) | Valid (1/1) | Valid (1/1) | Valid (1/1) | +| Wind | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | +| Precipitation | Small Obstacles (0.5/1) | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | +| Solar Irradiance | Small Obstacles (0.5/1) | No Obstacles (1/1) | Small Obstacles (0.5/1) | No Obstacles (1/1) | +| Orientation | East | West | South | North | +| | | | | | + +This is a type of station installation we encounter often. Although the total height of the station from the ground matches the recommended mast height, the installation is problematic: +- The fence creates friction with the air, causing the flow to slow down and generate turbulent currents that make the anemometer record different wind directions and usually lower wind speeds than the prevailing ones. +- The station is very close to the fence material, and it is likely that the sensor records higher temperatures than expected. +- Tall trees are very close to the station and likely block both the airflow and the sun’s rays. + +### The Short-Mast Roof Station + +| SPV Aspect | Decision Photo 1 | Decision Photo 2 | Decision Photo 3 | Decision Photo 4 | +|----------------------|-------------------------------|-------------------------------|-------------------------------|-------------------| +| Photo Validity | Valid (1/1) | Valid (1/1) | Valid (1/1) | - (0/1) | +| Mast Height | Mid | Mid | Mid | - | +| Mast Inclination | Not Inclined | Not Inclined | Not Inclined | - | +| Temperature and RH | Partly Affected (0.5/1) | Partly Affected (0.5/1) | Partly Affected (0.5/1) | - | +| Wind | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | Small Obstacles (0.5/1) | - | +| Precipitation | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Solar Irradiance | No Obstacles (1/1) | No Obstacles (1/1) | No Obstacles (1/1) | - | +| Orientation | West | North | East | - | +| | | | | - | + +This station represents another common deployment method we often observe. Despite being installed on a roof, the recommended installation guidelines have not been followed: +- The photo that would depict the southern horizon is missing. If it were available, it would likely show that the roof reaches a level higher than the station, blocking at least the airflow (if not also sunlight when the sun is low, for example). If the station were placed at the roof’s peak on a mast of at least 1.25 m, the roof would not have a significant impact on wind and temperature measurements. +- The mast is much lower than the recommended height, and the temperature measurements are certainly affected by the dark-coloured roof. +- Airflow slows down near the roof tiles, and the building across the way, which has a higher roof, also partially blocks the wind. diff --git a/static/llms-pages/weather-and-science/r&d.md b/static/llms-pages/weather-and-science/r&d.md new file mode 100644 index 00000000..283c2516 --- /dev/null +++ b/static/llms-pages/weather-and-science/r&d.md @@ -0,0 +1,13 @@ +# Weather R&D + +Canonical: https://docs.weatherxm.com/weather-and-science/r&d + +# Weather R&D + +In this section you can find material that has resulted from internal research conducted at WeatherXM, which served as the basis for mechanisms and optimisations. + +## Contents + +- [**Obstacle Impact on Temperature and Wind**](/weather-and-science/r&d/obstacle-impact-on-temp-and-wind.mdx): Analysis of experimental data for the investigation of the effect of obstacles (such as walls) in close proximity around a station on temperature and wind parameters. +- [**SQC - Constancy Analysis Report**](/weather-and-science/r&d/sqc-constancy-analysis-report.mdx): Analysis of data from properly deployed WeatherXM stations distributed worldwide, with the aim of determining the conditions under which various parameters can remain constant for hours. +- [**Theoretical Solar Irradiance**](/weather-and-science/r&d/theoretical-solar-radiation.mdx): The method used for calculating the theoretical solar irradiance for a given date of the year and location of the world. diff --git a/static/llms-pages/weather-and-science/r&d/theoretical-solar-radiation.md b/static/llms-pages/weather-and-science/r&d/theoretical-solar-radiation.md new file mode 100644 index 00000000..51240c58 --- /dev/null +++ b/static/llms-pages/weather-and-science/r&d/theoretical-solar-radiation.md @@ -0,0 +1,199 @@ +# Theoretical solar Irradiance + +Canonical: https://docs.weatherxm.com/weather-and-science/r&d/theoretical-solar-radiation + +# Theoretical Solar Irradiance +Dr. Stavros Keppas, 07/06/2023 + +## Calculating the theoretical solar irradiance + +The theoretical diurnal solar irradiance varies with the latitude, the day (of the year) and the time during the day. It can be calculated through the calculations described below (Mikulović et al., 2015). This methodology has been developed in order to be applied on data of 1-minute temporal resolution. The input variables are displayed in Table 1, while the required for calculations constants are shown in Table 2. + +**Table 1** - Input variables and their format/units + +| Variable | Format and Units | +|---------------|---------------------------------------------------| +| Latitude | decimal in °, e.g., 40.52° (use 2 decimals) | +| Longitude | decimal in °, e.g., 15.25° (use 2 decimals) | +| Date | YYYY-MM-DD, e.g., 2022-08-01 | +| DT (Local Hour - GMT) | In hours | +| Local Hour | Integer between 0-23 | +| Local Minute | Integer between 0-59 | +| Julian Day | e.g., 25/2 is the day 56 | + +**Table 2** - Constants that are used in the calculations + +| Constant Variable | Value | +|--------------------------|-------------------------------------------| +| Solar Constant (σ) | 1367 W m−2 | +| Reflective Coefficient | 0.2 (for ordinary ground or grass) | + +The Julian day can be calculated using the datetime module in python and the following commands: + +```python +fmt='%Y-%m-%d' +sdtdate = datetime.strptime(date, fmt) +sdtdate = sdtdate.timetuple() +local_day = sdtdate.tm_yday +``` + +Then, a series of calculations for the last 30-minutes in a 1-minute time interval to obtain the theoretical solar irradiance. Firstly, we calculate the **Sky Diffusion factor (SDF):** + +$$ +SDF = 0.095 + 0.04 \cdot \sin\left(\frac{360}{d_{totyear}} \cdot (d_{Julian} - 100) \cdot \frac{\pi}{180}\right) \tag{1} +$$ + +Where $d_{totyear}$ is the total number of days of the current year (365 for a typical year or 366 for a leap year) and $d_{Julian}$ the Julian day (see Table 1). + +Next, through the **Equation of Time (EoT)** we calculate the deviation between the solar time and the time shown by a typical clock: + +$$ +EoT = 9.87 \cdot \sin(2b) - 7.53 \cdot \cos(b) - 1.5 \cdot \sin(b) \tag{2} +$$ + +Where + +$$ +b = \frac{360}{d_{totyear} - 1} \cdot (d_{Julian} - 81) \cdot \frac{\pi}{180} +$$ + +The angle $\delta$ between the equator and the line drawn from the centre of the sun to the centre of the Earth can be obtained by the following equation: + +$$ +\delta = 23.45 \cdot \sin\!\left(\frac{360}{d_{totyear}} \cdot (d_{Julian} - 81) \cdot \frac{\pi}{180}\right) \tag{3} +$$ + +We also need to know the local time at which the sun is at the zenith (thus the local time of the solar noon) **SN**: + +$$ +SN = \frac{(12 \cdot 60) - 4 \cdot (Lon - LSTM) - EoT}{60} \tag{4} +$$ + +Where **Lon** is the longitude of the region and **LSTM** the local meridian calculated as: + +$$ +LSTM = 15 \cdot DT +$$ + +(for **DT** and **EoT** see Table 1). + +Then, we calculate the angle that the Earth must or has rotated so the sun is directly above the meridian of the region: + +$$ +HRA = 15 \cdot (SN - LT) \tag{5} +$$ + +Where **LT** is the local time in decimal format, calculated as: + +$$ +LT = local\_hour + \frac{local\_minute}{60} +$$ + +Next, we can now calculate the altitude (**SA**) of the sun from the horizon: + +$$ +SA = \frac{180}{\pi} \cdot \arcsin\Big( +\cos\Big(\frac{Lat \cdot \pi}{180}\Big) \cdot \cos\Big(\frac{\delta \cdot \pi}{180}\Big) \cdot \cos\Big(\frac{HRA \cdot \pi}{180}\Big) ++ \sin\Big(\frac{Lat \cdot \pi}{180}\Big) \cdot \sin\Big(\frac{\delta \cdot \pi}{180}\Big) +\Big) \tag{6} +$$ + +Where **Lat** is the latitude and **Lon** is the longitude of the region. + +The Extraterrestrial Solar Insolation (**IO**), which is the solar radiation that hits the top of the atmosphere, is given by: + +$$ +IO = \sigma \cdot \Big( 1 + 0.034 \cdot \cos\Big(\frac{360 \cdot d_{Julian}}{d_{totyear}} \cdot \frac{\pi}{180}\Big) \Big) \tag{7} +$$ + +Where **σ** is the solar constant (see Table 1). + +The Apparent Extraterrestrial Solar Insolation (**A**), then, is given by the following formula: + +$$ +A = 1160 + 75 \cdot \sin\Big( \frac{360}{d_{totyear}} (d_{Julian} - 275) \cdot \frac{\pi}{180} \Big) \tag{7} +$$ + +In order to simulate the average clarity of the atmosphere, we need to estimate its optical depth (**OD**): + +$$ +OD = 0.174 + 0.035 \cdot \sin\Big( \frac{360}{d_{totyear}} (d_{Julian} - 100) \cdot \frac{\pi}{180} \Big) \tag{8} +$$ + +However, we also need the **Air Mass Ratio (AMR)**, which is a measure indicating the distance that the solar ray travels within the atmosphere: + +$$ +AMR = \Bigg| \frac{1}{\sin\Big(\frac{SA \cdot \pi}{180}\Big)} \Bigg| \tag{9} +$$ + +We should also consider that the light sensor is a horizontally-aligned surface. In this case, the angle of incidence (**AoI**) is: + +$$ +AoI = \sin\Big(\frac{SA \cdot \pi}{180}\Big) \cdot \cos(0) \tag{10} +$$ + +Then, we are finally able to estimate the clear sky irradiance at Earth’s surface that hits a surface facing directly to the sun (**IB**), the irradiance that reaches the horizontally-aligned surface (**IBC**) and the irradiance reaching the surface after diffusion (**IDC**): + +$$ +IB = A \cdot e^{(-1) \cdot OD \cdot AMR} \quad \text{(If SA = 0, IB = 0)} \tag{11} +$$ + +$$ +IBC = IB \cdot AoI \tag{12} +$$ + +$$ +IDC = SDF \cdot IB \tag{13} +$$ + +Eventually, the total radiation (**IC**) that hits the light sensor is considered to be the summation of **IBC** and **IDC**: + +$$ +IC = IBC + IDC \quad \text{(in W m−2)} \tag{14} +$$ + +In order to apply a more realistic approach that is closer to the observed solar radiation, we used monthly constants suggested by the *Nijegorodov Model* (Nijegorodov, 1996; Ahmad and Tiwari, 2011) (**Table 3**). + +**Table 3 - Monthly constants for correcting theoretical solar radiation as suggested by Nijegorodov (1996).** + +| Month | Jan | Feb | Mar | Apr | May | Jun | Jul | Aug | Sep | Oct | Nov | Dec | +|:------|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:| +| **a** | 1163 | 1151 | 1142 | 1146 | 1152 | 1157 | 1158 | 1152 | 1150 | 1156 | 1167 | 1169 | +| **b** | 0.177| 0.174| 0.170| 0.165| 0.162| 0.160| 0.159| 0.164| 0.167| 0.172| 0.174| 0.177 | +| **c** | 0.114| 0.112| 0.110| 0.105| 0.101| 0.098| 0.100| 0.103| 0.107| 0.111| 0.113| 0.115 | + +Then, cos(θz) (θz is the solar zenith angle) is given by: + +$$ +\cos(\theta_z) = \sin(\text{lat}) \cdot \sin(\delta) + \cos(\text{lat}) \cdot \cos(\delta) \cdot \cos(\text{HRA}) \tag{15} +$$ + +In order to avoid any weird values (when solar angle is around the sunrise or sunset time) in the latter calculations: + +$$ +\cos(\theta_z) = 0.1 \quad \text{when} \quad \cos(\theta_z) < 0.001 +$$ + +Then, **IBC** is calculated from the following relationship instead of (12) (therefore (10) should not be used as well): + +$$ +IBC_{NM} = A \cdot \exp \left( \frac{-B}{\cos(\theta_z)} \right) \tag{16} +$$ + +Where *A* and *B* are given in **Table 3**. + +Next, **IDC** is corrected as: + +$$ +IDC_{NM} = C \cdot IDC \tag{17} +$$ + +Where *C* are given in **Table 3**. + +Finally, replacing (14), we use $IBC_{NM}$ and $IDC_{NM}$ in the following equation to calculate **IC**: + +$$ +IC = IBC_{NM} \cdot \cos(\theta_z) + IDC \tag{18} +$$ + +Note that $IC < 0$ should be replaced by $0 \, W/m^2$. diff --git a/static/llms-pages/weather-and-science/weatherxm-vs-wmo-compliant.md b/static/llms-pages/weather-and-science/weatherxm-vs-wmo-compliant.md new file mode 100644 index 00000000..3e959078 --- /dev/null +++ b/static/llms-pages/weather-and-science/weatherxm-vs-wmo-compliant.md @@ -0,0 +1,167 @@ +# Comparing WeatherXM with WMO Compliant Weather Stations + +Canonical: https://docs.weatherxm.com/weather-and-science/weatherxm-vs-wmo-compliant + +Dr. Stavros Keppas, 30/10/23 - WeatherXM AG + +## 1. Introduction +In the pursuit of high-quality meteorological data, we aim to identify potential systematic errors and failures that the various WeatherXM station models may exhibit. For this reason, in the present study we compare impeccably installed WeatherXM weather stations, as assessed by the [SPV](https://docs.weatherxm.com/weather-and-science/quality-mechanisms/spv-full-documentation) mechanism (and the installation photos), with nearby meteorological stations that provide data via SYNOP. + +## 2. Data and Methods +In general, there is an inconsistency between airport data and that from WeatherXM stations, mainly in terms of the temporal sampling interval, but also in the set of available parameters. + +WeatherXM stations, under normal conditions (good connectivity), provide data every 1–3 minutes, whereas airport stations provide data every 30–180 minutes. For this reason, we aggregated WeatherXM's data in such a way that both data are aligend. For the aggregation method we averaged the observations 5 minutes before and after the timestamp of the WMO complinat station data (vector average for wind direction). In addition, the parameters provided by WeatherXM stations are consistent, while the parameters from airport stations often vary from station to station (for example, sometimes wind gust is missing, or the time step used for recording precipitation differs). + +Finally, although the reliability of satellite precipitation retrievals is not yet at a level where we could fully trust them, we use the [IMERG](https://gpm.nasa.gov/data/imerg) product with a spatial resolution of 0.1°. It is worth noting, however, that for the latest 3 months the data are only partially processed and may therefore have lower reliability. Full processing takes place after the 3-month period. + +## 3. Comparisons +### a. Thessaloniki Airport (Greece) vs WeatherXM H1 + +For this comparison, we used the data (between 11/2024 - 11/2025) from SYN16622 (SYNOP Mesonet) at the Thessaloniki Airport and the WeatherXM H1 station ([Humid Myrtle Hygrometer](https://explorer.weatherxm.com/stations/humid-myrtle-hygrometer)). The distance between the two stations is <2km, which allows for a valid comparison between them (**Figure 1**). + + + + **Figure 1**. (Left) Map with the locations and the distance between the SYN16622 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 2**, we can draw some useful conclusions, which are summarised in the following points: +- There is fair temperature agreement (usually WXM is lower - possible reasons could be the slightly different land use, lower mast leading to lower temperature in cloudless nights) +- There is fair wind direction agreement +- The weatherXM station underestimates wind speed/gust possibly due to shorter mast (3m instead of 10m) +- Significant discrepancy in precipitation, which needs further investigation + + + + **Figure 2**. Agreement plots between SYNOP16622 and WeatherXM H1 temperature, daily precipitation, wind speed, wind gust and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The SYNOP16622 wind gusts are never 0m/s at the airport, which may be due to a very sensitive wind gauge under calm conditions. Regarding precipitation, it seems that there is some agreement between SYNOP16622 and WeatherXM, but there is some difference in rain amount on certain episodes. It should be noted that the SYNOP16622 has larger distance from IMERG (**Figure 3**). + + + + **Figure 3**. Temperature, wind gust and daily precipitation time series plots of both SYNOP16622 and WeatherXM H1. + + +As we detected a significant deviation in precipitation recorded by WeatherXM H1 and SYN16622, we tried to find more references in order to understand which could be the ground truth. For this reason we used monthly accumulation from the Davis VP2 weather station supported by the National Observatory of Athens (NOA) (which is located ~3-4km from SYN16622 and WeatherXM H1) and IMERG precipitation retrievals. + +It seems that the WeatherXM H1 station is usually closer to any of IMERG and NOA (Davis VP2), while SYN16622 is far from all the other references. In particular, SYN16622 seems to significantly underestimate monthly precipitation by up to ~50% even in winter months (when precipitation may exhibit a more uniform spatial distribution as convective activity is limited in the area). + + + + **Figure 4**. (Left) Map with the locations and the distance between the SYN16622 (WMO), WeatherXM H1 and the National Observatory of Athens stations. (Right) Bar graph of total monthly precipitation recorded by the 3 stations and retrieved by IMERG. + + +### b. Rockwall Municipal Airport (Dallas) vs WeatherXM H2 + +For this comparison, we used the data (between 11/2024 - 11/2025) from KF46 (ASOS/AWOS Mesonet - Following some general WMO guidelines) at the Rockwall Municipal Airport and the WeatherXM H1 station ([Dandy Marigold Rainband](https://explorer.weatherxm.com/stations/dandy-marigold-rainband)). The distance between the two stations is ~20km over a flat area, which may allow for a valid comparison between them (**Figure 5**). + + + + **Figure 5**. (Left) Map with the locations and the distance between the KF46 and the WeatherXM H2 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 6**, we can draw some useful conclusions, which are summarised in the following points: +- There is a fair temperature agreement +- There is a fair wind direction agreement +- WeatherXM H2 seems to underestimate wind speed/gust due to shorter mast (3m instead of 10m) +- A weird cut-off threshold is present in wind speed/gust observations recorded by the KF46 +- There is a reasonable discrepancy in precipitation. The distance between stations can justify such differences especially during summer (due to convective activity) + + + + **Figure 6**. Agreement plots between KF46 and WeatherXM H2 temperature, daily precipitation, wind speed, wind gust and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The KF46 wind gusts are never 0m/s at the airport, and usually >7m/s (which may be suspicious). Regarding precipitation, it seems that there is a fair agreement between KF46, WeatherXM and IMERG considering the distance between the stations (**Figure 7**). + + + + **Figure 7**. Temperature, wind gust and daily precipitation time series plots of both KF46 and WeatherXM H2. + + +Finally, comparing the stations between them and both with the monthly IMERG precipitation retrievals, we found that all three sources of precipitation measurements are usually in fair agreement. KF46 and WeatherXM H2 are often close each other, while large discrepancies in certain months may be due to convective activity and distance between stations. + + + + **Figure 8**. Bar graph of total monthly precipitation recorded by the the KF46 (WMO), WeatherXM H2 stations and retrieved by IMERG. + + +### c. Osijek Airport (Croatia) vs WeatherXM H1 + +For this comparison, we used the data (between 11/2024 - 11/2025) from SYN14280 (SYNOP Mesonet) at the Osijek Airport and the WeatherXM H1 station ([Convective Chestnut Moisture](https://explorer.weatherxm.com/stations/convective-chestnut-moisture)). The distance between the two stations is ~14km over a generally flat area, which may allow for a valid comparison between them (**Figure 9**). + + + + **Figure 9**. (Left) Map with the locations and the distance between the SYN14280 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 10**, we can draw some useful conclusions, which are summarised in the following points: +- There is a fair temperature agreement +- There is a fair wind direction agreement (possibly because the WeatherXM station is ~10m above the ground and thus, the deployments are comparable) +- WeatherXM H1 seems to slightly underestimate wind speed/gust due to shorter mast (3m instead of 10m) +- The wind gust measurements were not available from the SYN14280 station, so no comparison could be conducted +- Some discrepancy in precipitation is present. The distance between station may be able to justify such differences especially during summer. + + + + **Figure 10**. Agreement plots between SYN14280 and WeatherXM H1 temperature, daily precipitation, wind speed and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Looking at the full time series of temperature, wind gusts and daily precipitation, we can see that, broadly, variations seem to be in agreement. The SYN14280 usually records lower amounts of precipitation comparing to the WeatherXM H1 and IMERG. However, during summertime, it seems that SYN14280 recorded larger amounts, which may be due to intense convective activity (**Figure 11-12**). + + + + **Figure 11**. Temperature, wind gust and daily precipitation time series plots of both SYN14280 and WeatherXM H1. + + + + + **Figure 12**. Bar graph of total monthly precipitation recorded by the the SYN14280 (WMO), WeatherXM H1 stations and retrieved by IMERG. + + +### d. Kortrjik Airport (Belgium) vs WeatherXM H1 + +For this comparison, we used the data (between 03/2024 - 11/2025) from SYN06414 (SYNOP Mesonet) at the Kortrjik Airport and the WeatherXM H1 station ([Hot Nickel Stratus](https://explorer.weatherxm.com/stations/hot-nickel-stratus)). The distance between the two stations is ~14km over a generally flat area, which may allow for a valid comparison between them (**Figure 13**). + + + + **Figure 13**. (Left) Map with the locations and the distance between the SYN06414 and the WeatherXM H1 stations. (Right) WeatherXM H1 deployment photo. + + +From **Figure 14**, we can draw some useful conclusions, which are summarised in the following points: +- There is fair temperature agreement +- There is fair wind direction agreement +- There is also fair wind speed agreement +- Wind gust measurements are not available from WMO's station +- We found some discrepancy in precipitation between the two stations. WeatherXM station seems to catch rain episodes that WMO misses. This may happen during convective phenomena, but it needs further investigation. + + + + **Figure 14**. Agreement plots between SYN06414 and WeatherXM H1 temperature, daily precipitation, wind speed and wind direction. The markers are coloured depending on their distance from the agreement line. + + +Broadly, variations seem to be in agreement. There is a fair agreement in wind speed measurements despite the possible difference in mast height of the stations. Again, WeatherXM often measures larger amount of rain than WMO's station. However, there is coincidence of most episodes. Unfortunately, IMERG seems to exhibit false positives especially after August (**Figure 15**). + + + + **Figure 15**. Temperature, wind gust and daily precipitation time series plots of both SYN06414 and WeatherXM H1. + + +Looking at the monthly accumulations of precipitation (**Figure 16**), we can see significant discrepancy between the WMO, WeatherXM stations and IMERG retrieval. Although WeatherXM station seems to be closer to IMERG, it eventually seems that a reliable ground truth is missing. + + + + **Figure 16**. Bar graph of total monthly precipitation recorded by the the SYN06414 (WMO), WeatherXM H1 stations and retrieved by IMERG. + + +## 3. Conclusions + +After investigating a few couples of WeatherXM, we draw the following conclusions: +- There is always a fair agreement in temperature in all couples +- There is a fair agreement in wind direction (considering the variability of wind flow due to topography and even artificial objects) +- In general there is a good agreement in wind speed considering that WeatherXM stations are mounted on 3m masts instead of 10m. However, there was a great agreement when a WeatherXM station was mounted on the roof of a ~10m building. +- The wind speed observations recorded by WMO’s stations are sometime in intervals of 0.5-1m/s, which may raise questions on accuracy. +- There are cases of data gaps in precipitation recorded by WMO stations resulting to mising episodes. +- WMO’s large discrepancy in precipitation even when WeatherXM stations are as far as ~1-2km. IMERG and 3rd party realiable stations confirm the WMO’s inaccuracy in precipitation is some cases. +- The WeatherXM stations usually record larger amount of rain per episode. Considering that the rain gauge is shallow and with small diameter, we would expect WMO stations to record systematically larger amounts of rain +- In the end, it seems that we are still in the pursuit of publically available reference/ground truth observations of precipitation diff --git a/static/llms-pages/weatherxm-pro.md b/static/llms-pages/weatherxm-pro.md new file mode 100644 index 00000000..e382433a --- /dev/null +++ b/static/llms-pages/weatherxm-pro.md @@ -0,0 +1,52 @@ +# WeatherXM Pro + +Canonical: https://docs.weatherxm.com/weatherxm-pro + +## Access Hyperlocal Weather Data + +Improve your forecasts with our global weather station network. +Access hyperlocal data to optimize decisions and boost efficiency. Explore the [Pro](https://pro.weatherxm.com) **for free** and view nearby station data! +You can use either our user-friendly web interface, or easily integrate it with your solution via our API. + +:::note +Explore our WeatherXM Pro at [pro.weatherxm.com](https://pro.weatherxm.com) or [view its API documentation](https://pro.weatherxm.com/docs). +::: + +## Features + +### Historical & Real-Time Data +Access real-time and historical weather data from any WeatherXM station across the globe — delivered +seamlessly to your app for immediate insights and long-term analysis. + +### Forecast Accuracy Tracking + +
+ Continuously monitor and compare the performance of 40+ leading global weather models to identify the most accurate forecasts for your specific location. + This empowers you to make smarter, weather-driven decisions and optimize operations with confidence. + + For example: + - Agriculture: Choose the most reliable forecast to plan irrigation, planting, or harvest timing and reduce crop risk due to unexpected weather shifts. + - Energy: Improve load forecasting and renewable generation planning by using the most accurate model for wind or solar predictions. +
+ + +### Hyperlocal Station Forecasts + +
+ Get hyperlocal forecasts tailored to specific locations by leveraging our global network of weather stations. + Unlike traditional models, the Pro improves forecasts using real-world, ground-truth data from local stations. + + Our QoD mechanism ensures high data reliability by motivating and rewarding station owners to maintain their devices. + The better the station’s performance, the more rewards they earn—ensuring consistently high-quality data for businesses. +
+ + +### Access hyperlocal weather data via API +Access real-time, historical and forecast weather data effortlessly with our [developer-friendly API](https://pro.weatherxm.com/docs) +— built for seamless integration into your apps, platforms, and operational workflows. +Tap into high-quality data from a trusted global network, with 90%+ coverage reliability and quality. +[View our Pro API documentation here.](https://pro.weatherxm.com/docs) + +:::note +Explore our WeatherXM Pro at [pro.weatherxm.com](https://pro.weatherxm.com) or [view its API documentation](https://pro.weatherxm.com/docs). +::: diff --git a/static/llms-pages/wxm-devices/d1/assemble.md b/static/llms-pages/wxm-devices/d1/assemble.md new file mode 100644 index 00000000..8c5399a4 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/assemble.md @@ -0,0 +1,174 @@ +# Assembling WS1001 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/assemble + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + +The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) +and another that measures the wind direction (though wind vane). +Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, +which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. +The wind vane should be placed on the shaft at the bottom of the sensor. +After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 20 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG1200 Gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +
+ +### External Battery pack installation + +While not mandatory, we strongly recommend the installation of the battery pack for the following reasons: + + 1. Extended Battery Life: Utilising only two batteries will result in the station depleting its power within 3 to 5 months, depending on environmental conditions. Installing the battery pack increases the battery life by approximately four times, significantly reducing the frequency of battery replacements. + 2. Improved Accessibility: The battery pack includes an extension cable (~3 meters), providing easier access for battery replacement when needed. + + + + 1. Open the Battery Pack: Begin by pulling the clip on the side of the battery pack to open it. + 2. Access the Battery Base: Gently pull out the battery base. You will see eight battery sockets arranged in groups of two (two pairs in the front and two in the back). + 3. Insert the Batteries: Place a battery in each socket, ensuring correct polarity alignment. + 4. Reassemble the Battery Pack: Carefully place the battery holders back into their original positions, ensuring they are oriented correctly (i.e., the cable should remain at the bottom and should not be twisted). + 5. Secure the Battery Pack: Close the lid of the battery pack and push the clip until it clicks into place. + 6. Prepare the Weather Station: On the weather station, remove the battery cover. + 7. Insert Dummy Batteries: Insert the dummy batteries into the station as you would with regular batteries, ensuring correct polarity. + 8. Close the Weather Station Cover: Close the embedded lid on the weather station and fasten the screw securely. + 9. Mount the Battery Pack: The battery pack can be attached to a pole using the two provided zip ties. + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing Bird Spikes +The bird spikes are designed to be installed on the rim of the rain cup to deter birds from perching on or around +the rain cup. + +#### Included Components + +Each weather station comes with the following bird spike components: + +- Metal Spikes +- Rim-Mounted Spike Holders: These are designed to fit around the edge of the rain cup. +- Metal Zip Ties: Two metal zip ties are included. Only one is required for installation; the second is provided as a spare. + +#### Installation Instructions + + 1. Prepare the Spike Holders: Insert a metal zip tie through each spike holder, ensuring that the holes are facing upward. + 2. Insert the Spikes: Place a metal spike into each hole on the spike holder. + + + + 3. Attach the Spike Holders to the Rain Cup: Wrap the zip tie around the rim of the rain cup and tighten it securely to prevent the spike holders from loosening or falling off. For easier installation, + it is recommended to first remove the rain cup by twisting it lightly before attaching the spike holders. + + + + 4. Secure the Metal Zip Tie: Carefully secure the metal zip tie on top of the rain cup to ensure the spike holders are firmly in place and will not fall off. + + + + 5. Place the spikes, short side down, in the designated spots on the ring. The final setup should match the image below. + + + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). diff --git a/static/llms-pages/wxm-devices/d1/connect-and-claim.md b/static/llms-pages/wxm-devices/d1/connect-and-claim.md new file mode 100644 index 00000000..3fab9808 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/connect-and-claim.md @@ -0,0 +1,179 @@ +# Connect and Claim the Gateway + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/connect-and-claim + +## WG1200 Gateway + +The weather station comes together with the WG1200 Gateway. +The WG1200 Gateway receives all the meteorological data plus the location of the weather station, which are measured and transmitted every 16 seconds by the outdoor sensor +and displays them on its screen. + +In this chapter, you will find guidance to set up the WG1200 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. A reliable 2.4 GHz WiFi network (**5 GHz is not supported**) for the WG1200 Gateway to connect to. +1. The [WeatherXM](/wxm-devices/d1/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +
+ +## Step by Step Instructions + +### Connect WG1200 Gateway to power source and turn the gateway on + +The WG1200 Gateway must be connected to a power source at all times. + +:::caution +If WG1200 Gateway turns off, you will not receive \$WXM rewards, as you will not be able to share data with the WeatherXM network. **This will result in no $WXM rewards!** +WG1200 does not have a battery, so it must be connected to a power source at all times. +::: +
+ +### Change Frequency (Optional) + + + +The WG1200 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 3 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz +- Model C: 923 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency + + + + + + +

+1. Swipe right on the touch screen. +1. Click the Frequency options and select the new frequency your WG1200 Gateway will listen to. +1. A confirmation dialog will open. Read it carefully and click "Continue" or "Cancel" accordingly. +1. Finally, your WG1200 Gateway will restart after setting the frequency to the selected one. + +:::caution +If you don't use the correct frequency as your weather station, WG1200 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Connect WG1200 Gateway to WiFi + + + + + +

+1. Swipe right on the touch screen and select the Configure WiFi option. +1. The WG1200 Gateway will restart to enter configuration mode. +1. An Access Point will be created with SSID "WXM_WG1200", you should connect to it from your smartphone. It is normal not having internet connection while connected to it. +1. Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +1. Enter your WiFi credentials and click "Save". +1. The WG1200 Gateway will restart and connect to your WiFi network. + +By now, your WG1200 Gateway is set and ready for claiming. + +:::tip +In case of a successful connection, and the popup doesn’t open, navigate with your browser to 10.10.0.1 and follow the instructions displayed. +::: + +:::note +While you are connected to the "WXM_WG1200" network, you will not have internet access. +::: + +#### Video Guide + + + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Prepare for claiming your WG1200 Gateway + + + + + #### Navigate to WG1200 Gateway and reveal the QR code + + Swipe right on the touch screen and select the "Claim Device" option, a QR code will appear. + + You'll need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + + +:::tip +In case you have trouble scanning the QR code, you can manually type the serial number and claiming key. +::: + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: diff --git a/static/llms-pages/wxm-devices/d1/contents.md b/static/llms-pages/wxm-devices/d1/contents.md new file mode 100644 index 00000000..ad9d65e5 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/contents.md @@ -0,0 +1,91 @@ +# Box Contents of D1 bundle (WB1200) + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/contents + +## Included + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Metal plate
    5. +
  5. U-bolts (x2)
    6. +
  6. Nuts (x4)
    7. +
  7. Wrench
    8. +
  8. Screwdriver
    9. +
  9. WG1200 Gateway
    10. +
  10. Power supply cable (USB-C)
    11. +
  11. External Battery Pack
    12. +
  12. Zip ties
    13. +
  13. Bird Spikes
    14. +
+ + +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole +1. USB power supply + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 20 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1001 Weather Station](/wxm-devices/m5/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG1200 Gateway (D1 WiFi) + + + +The WG1200 Gateway (D1 WiFi) is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via WiFi to the WeatherXM network. + +The D1 Gateway is advised to be placed indoors, in an environment of relatively constant temperature (ideally within a daily range of <4°C/7°F for proper functioning of the barometer). + +The D1 Gateway should be permanently connected to power and powered on in order to be able to receive, record and upload measurements to the Internet. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. diff --git a/static/llms-pages/wxm-devices/d1/install-weather-station.md b/static/llms-pages/wxm-devices/d1/install-weather-station.md new file mode 100644 index 00000000..3c7b8051 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/install-weather-station.md @@ -0,0 +1,31 @@ +# Installing WS1001 Weather station + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/install-weather-station + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ Thus, it is important that you are able to read all the measurements on the WG1200 Gateway's screen, + while you keep the outdoor sensor nearby (preferably not closer than 1.5m/5ft from the WG1200 Gateway though).
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. diff --git a/static/llms-pages/wxm-devices/d1/introduction.md b/static/llms-pages/wxm-devices/d1/introduction.md new file mode 100644 index 00000000..50691e26 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/introduction.md @@ -0,0 +1,160 @@ +# Introduction of D1 bundle (WB1200) + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/introduction + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG1200 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG1200 Gateway + +- 3.95" Capacitive touch screen +- ATECC608 hardware encryption +- BLE + LoRa +- Forwards weather data via WiFi +- Powered by USB (power adapter not included) +- Over-the-air firmware upgradable + +### WS1001 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG1200 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1200 is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 20sec + + + + + +Powered via a small solar panel and batteries and communicates with the WG1200 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1200 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + diff --git a/static/llms-pages/wxm-devices/d1/maintenance.md b/static/llms-pages/wxm-devices/d1/maintenance.md new file mode 100644 index 00000000..2d71c1c1 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/maintenance.md @@ -0,0 +1,33 @@ +# Maintenance of WS1001 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/maintenance + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG1200 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/d1/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: diff --git a/static/llms-pages/wxm-devices/d1/troubleshooting.md b/static/llms-pages/wxm-devices/d1/troubleshooting.md new file mode 100644 index 00000000..212cbc52 --- /dev/null +++ b/static/llms-pages/wxm-devices/d1/troubleshooting.md @@ -0,0 +1,171 @@ +# Troubleshooting of D1 bundle (WB1200) + +Canonical: https://docs.weatherxm.com/wxm-devices/d1/troubleshooting + +## Weather Station + +### Device Alert: "No Weather Station Signal" +![No Signal](image) + +If the error message "No Weather Station Signal" is displayed on the WG1200 Gateway, the WG1200 Gateway is not receiving RF signals. +This can be due to a variety of reasons. +Here are some steps to troubleshoot the issue: + +First make sure you WG1200 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/d1/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/d1/contents#outdoor-weather-station)) for flashing. +The LED should flash every 20 seconds. + +If the LED is not flashing every 20 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors, or the WG1200 Gateway has not been reset. +The solution may be as simple as powering down and up the WG1200 Gateway. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG1200 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. +1. WG1200 Gateway should display all the observations measured by the weather station. +1. Try to place the WG1200 Gateway at the desirable point and check that it receives data. + Ensure the power adapter if used is not too close to the WG1200 Gateway and the WG1200 Gateway is not close to other electrical noise generating devices + such as TVs, monitors, computers and transmitting devices. +1. If you still have intermittent problems, move the weather station and the WG1200 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG1200 Gateway. + Relocate the weather station and WG1200 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. + +
+ +### Device Alert: "Station Signal is Low" +![Signal Low](image) +When the RF connection with the Weather Station is weak, the WG1200 Gateway will display "Station Signal is Low" resulting to [Data Gaps](/rewards/rewards-troubleshooting#weather-data-gaps) and reduced Rewards. +- If the signal is low, make sure the weather station is within the range of 50m/164ft from the WG1200 Gateway. +- If the weather station is within the range, try to move the WG1200 Gateway in another location to improve the signal quality. + +:::note +Low signal quality may be due to obstacles between the weather station and the WG1200 Gateway, such as walls, trees, or other buildings. +::: + +
+ +### Device Alert: "Station Reported Abnormal Values" +![Abnormal Values](image) + +This message is displayed when the weather station reports values that are out of the ordinary. This can be due to a variety of reasons, such as: +- Spikes on the data measured. +- One or more variables are constant for long periods of time. +- A sensor may be defective. + +Please make sure you have followed [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### Device Alert: "Station Battery Level is Low" + +![Battery Low](image) + +If your WG1200 Gateway displays "Station Battery Level is Low" on the screen, the weather station will run out of battery soon. + +Replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by reading [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation). + +
+ +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/d1/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +
+ +### One or more variables are extremely high, low, or constant for long periods of time. + +If you notice that some variables are extreme or constant it is possible you need to replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Pressure on WG1200 Gateway appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +
+ +## WiFi Connectivity + +### Device Alert: "No Internet connection" + +![No WiFi](image) + + When the WiFi connection is lost, the warning "No Internet connection" is displayed on the WG1200 Gateway. + This can be due to a variety of reasons: +Here are some steps to troubleshoot the issue: + +- Make sure the WiFi network is working properly. +- If you have never been able to configure WiFi to a working state, make sure your WiFi supports 2.4 GHz signals. The gateway does not support WiFi that uses the 5 GHz spectrum. +- Make sure you configured the correct SSID and password. +- Repeat the [procedure](/wxm-devices/d1/connect-and-claim#connect-wg1200-gateway-to-wifi) if necessary to verify. + +If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### Wifi Repeater +Usually, using a WiFi repeater is not an issue, but in some cases it may affect your Gateway's connection. If you are experiencing issues with your WG1200 Gateway, try to connect it directly to your router and see if the problem persists. If it does not, +then the issue is with the repeater. If it does, please contact us through [support](https://support.weatherxm.com). + +
+ +### WG1200 Gateway not working in 5 GHz WiFi. +WG1200 Gateway is designed to work **only** at the 2.4GHz frequency. Please make sure the 2.4Ghz band on your router is enabled. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### I don't see the Wi-Fi name "WXM_WG1200" for initial setup on the app. + +It might take some time and attempts for it to connect. Please make sure that your Wi-Fi supports 2.4 GHz signals. You may also need to try from a different phone. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +## GPS Location + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## Other Issues + +### My WG1200 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### What can I do if my WG1200 Gateway is switching off frequently? + +Please disconnect the WG1200 Gateway from the power source and plug it back to the power source. You can also try using a different USB cable and another wall adapter. + +
+ +### Why is my station showing offline? + +Assuming that the WG1200 Gateway unit is powered on, this may be due to a bad internet connection or bad RF connection between the D1 Gateway and the outdoor station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: diff --git a/static/llms-pages/wxm-devices/deployment-examples.md b/static/llms-pages/wxm-devices/deployment-examples.md new file mode 100644 index 00000000..540f69dc --- /dev/null +++ b/static/llms-pages/wxm-devices/deployment-examples.md @@ -0,0 +1,220 @@ +# Weather Station Deployment Examples + +Canonical: https://docs.weatherxm.com/wxm-devices/deployment-examples + +Real-world examples of good and problematic WeatherXM weather station installations, with guidance on mast height, obstacles, wind exposure, rain, temperature and solar radiation. + +Use these real-world examples to evaluate where to install a WeatherXM station and how nearby roofs, walls, trees, fences and chimneys can affect measurements. For the best data quality, place the outdoor sensor as high and as clear of nearby obstacles as practical, following the installation guidance for your station model. + +## Good Installations + +### Case 1 + + ![WeatherXM station installed high above an apartment roof on a tall mast](image) + + The station has been deployed at the highest point of this apartment, which is located at an area, where buildings present similar heights. Thus, the outdoor sensor is over the level of any object around. It is also placed on a >2m mast and, hence, temperature/humidity is not affected by the roof’s material. + + +
+ +### Case 2 + + + ![WeatherXM station on a rooftop with a clear horizon and nearby trees below sensor level](image) + ![Second view of a rooftop WeatherXM station with mostly unobstructed exposure](image) + + + + The station has been deployed at the highest point of this apartment, which is located at an area, where other obstacles are not much higher. Notice that the level of the outdoor sensor is very close to the level of the tree tops, and so wind/rain measurements shouldn’t be affected. It is also placed on a >2m mast and, hence, temperature/humidity is not affected by the roof’s material. + + + + +
+ +### Case 3 + + ![WeatherXM station on a very tall mast above a roof and sparse palm trees](image) + + The station has been deployed at the highest point of this apartment, which is located at an area, where other obstacles are not much higher. In addition, the mast is ~7m makes the deployment quite ideal. Sparse thin coconut trees shouldn’t be able to affect measurements. In a case like that the user should tight firmly the wires that stabilise the mast. Otherwise, the mast may significantly oscillate, producing faulty wind and especially rain measurements. + + +
+ +### Case 4 + + + ![WeatherXM station on a 2.5 metre mast in an open area with a clear horizon](image) + ![Second view of an open WeatherXM station deployment with a distant house](image) + + + + The station has been deployed at a 2.5m mast with a clear horizon with no obstacles. The only obstacle is a house (4-7m height) being located at the east, but it’s 25m away.Thus, the maximum difference of obstacle-station level heights is 7-2.5=4.5m, which means that the distance is at least >5 times the height of the obstacle. Although the station is considered as well deployed, optionally would be placed on a 5m mast to completely follow the WMO criteria. + + + + +
+ +## Deployments that need attention + +### Case 5 + + + ![WeatherXM station mounted near a fence, bush and surrounding buildings](image) + ![Second view of a WeatherXM station with nearby fence and vegetation obstacles](image) + + + + The station has not been deployed at the highest possible place because there are higher buildings around. It is placed on a fence being only ~1m higher from it and there are objects (like the bush) that are closer than 2m, which is the smallest allowed distance between the sensors and any horizontal surface under the level of the outdoor sensor. + + + +:::caution +The fence can cause turbulence that may affect the wind measurements. The buildings around may create a “wind shade” and, thus, wind speed will be lower than expected, while wind direction will be more variable than expected. Finally, as the bush is quite close, this may affect temperature and humidity but in a less significant way. Solar radiation may not be affected, but there are not enough photos to come to such a conclusion. +::: + +:::tip +The station should be moved to the terrace of the house (which is not visible in the photos). If the house terrace is at the level of the surrounding terraces and the outdoor sensor is placed on a >2m mast, then the weather station should be considered as well deployed. +::: + +
+ +### Case 6 + + + ![East-facing view from a WeatherXM station surrounded by trees](image) + ![North-facing view from a WeatherXM station surrounded by trees](image) + + + ![South-facing view from a WeatherXM station surrounded by trees](image) + ![West-facing view and obstacle context for a WeatherXM station deployment](image) + + + + Photos showing from left to right the East - North - South - West horizon of the outdoor sensor. The last photo at the bottom shows Google Maps top view of the area together with distances from the surrounding obstacles + + + +:::note +The station sits in an area surrounded by tall trees some of which are too close to the station especially to the south and west. +::: + +:::caution +The trees at the west and south have a significant impact on wind speed/direction (block the flow), solar radiation (as they shade the sensor), rain measurements (e.g., rain with south wind will be underestimated as trees create a “rain shade”), temperature and humidity possibly in a more insignificant way (as sun turns from east to west through the day, the sensor will differentially be shaded from time to time recording variable and changing temperature and humidity). +::: + +:::tip + + ![Suggested nearby rooftop location for improving a WeatherXM station deployment](image) + + The station could ideally be moved to the roof of the nearby building (using a 3-4m-mast) in order to be placed as higher as possible to avoid at least the closest obstacles. Otherwise (if there is no other available place) a 5-7m-mast could be used at the same place in order to place the weather station above the level of the closer obstacles. + + +::: + +
+ +### Case 7 + + ![WeatherXM station mounted only slightly above a wooden structure](image) + + The station is placed just a few tens of centimetres over a wooden structure. From this photo it is unknown if there are any obstacles at the north-east-south. + + +:::caution +The wooden structure may cause turbulent air flow that would have a significant impact on wind measurements. If there are obstacles at the blind side, they could affect measurements in variable ways. +::: + +:::tip +The outdoor sensor should be placed on a higher mast (at least a 2m one) over the wooden structure. If there are higher buildings etc around, the sensor should be moved at the highest possible point (always using a at least 2m mast). +::: + +
+ +### Case 8 + + + ![WeatherXM rooftop station before raising the sensor farther above nearby obstacles](image) + ![WeatherXM rooftop station after raising the sensor to improve exposure](image) + + + + Photos show before (left) and after (right) of the deployment of a station in order to optimise its position. + + + +:::note +The station is placed on the roof of a building, but there are tall trees to the west. +::: + +:::caution +Tall trees will affect rain and wind measurements when wind blows from the west. According to WMO a wind gauge should be placed at a distance 10 times the higher obstacle height. +::: + +:::tip +The user moved the outdoor sensor higher by ~1m increasing the distance-height ratio (distance from obstacle/ height of obstacle-height of outdoor sensor) from 2 to 3. In such a case there’s no better solution than that. Ideally, the mast should be 4-6m above the roof, but the maintenance may not be a safe job. +::: + +
+ +### Case 9 + + + ![WeatherXM station mounted beside and below the top of a chimney structure](image) + + + + The station is deployed on the east side of a chimney structure below its top level and close by chimneys. + + + +:::caution +The structure causes rain and especially wind shade. Wind speed and particularly wind direction may significantly differ from the actual situation even when wind blows from other than west directions. Moreover, if the chimney is active, temperature will be systematically higher. +::: + +:::tip +In case that chimney is inactive, the outdoor sensor should be placed at the same position but on a (at least) 2m mast. If the chimney is active, then the sensor should be placed at least 5 meters away and again on a 2m (or more) mast. +::: + +
+ +### Case 10 + + + ![WeatherXM station installed on a balcony close to a wall and roof](image) + + + + The station is deployed on a balcony with a wall and a roof being fairly close (to the west). + + + +:::caution +The roof and the wall are significant obstacles affecting all of the measured meteorological parameters (e.g., missing rain episodes, incorrect wind speed and direction, increased temperature). +::: + +:::tip +A balcony is not a place for a weather station. The station should be moved to the roof of this apartment following the general guidelines. +::: + +
+ +### Case 11 + + + ![WeatherXM station near a chimney with taller buildings and trees around it](image) + + + + The station is deployed on an appropriate mast, but it is not at the highest possible point of the area (there is a higher building to the north and tall trees to the south). There is also a chimney below it. + + + +:::caution +If the chimney is active, then temperature will be systematically increased. Due to taller obstacles around, wind and rain will include significant errors. +::: + +:::tip +The station should be moved to the higher roof as far as possible from the chimneys on a tallest possible mast in order to skip the tall tree obstacle to the south. +::: diff --git a/static/llms-pages/wxm-devices/frequency-explanation-d1-m5-pulse.md b/static/llms-pages/wxm-devices/frequency-explanation-d1-m5-pulse.md new file mode 100644 index 00000000..242753e2 --- /dev/null +++ b/static/llms-pages/wxm-devices/frequency-explanation-d1-m5-pulse.md @@ -0,0 +1,11 @@ +# frequency-explanation-d1-m5-pulse + +Canonical: https://docs.weatherxm.com/wxm-devices/frequency-explanation-d1-m5-pulse + +import 'tippy.js/dist/tippy.css'; // optional + + + + diff --git a/static/llms-pages/wxm-devices/frequency-plans.md b/static/llms-pages/wxm-devices/frequency-plans.md new file mode 100644 index 00000000..f3874900 --- /dev/null +++ b/static/llms-pages/wxm-devices/frequency-plans.md @@ -0,0 +1,405 @@ +# Frequency Plans + +Canonical: https://docs.weatherxm.com/wxm-devices/frequency-plans + +In this page you can find a mapping table listing all ISM band frequency plans per country, +as well as the corresponding frequency used by our products in these countries. + +:::tip +If a country's ISM frequency is marked as "-" or it is not listed, you are advised to check with the +country's regulations and use the appropriate frequency. You can find the respective +regulatory body for each country in the list [here](https://en.wikipedia.org/wiki/List_of_telecommunications_regulatory_bodies#By_country). +::: + +Source: [LoRaWAN Regional Parameters RP002-1.0.5](https://resources.lora-alliance.org/technical-specifications/rp002-1-0-5-lorawan-regional-parameters) (Published October 8, 2025). This document describes Regional Parameters worldwide, and the country cross-reference table is intended as a quick reference of unlicensed bands and suggested channel plans. + +## A + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|----------------|---------------| +| Afghanistan | AF | - | | Check Helium Explorer | +| Aland Islands | AX | EU868 | EU868 | ✓ | +| Albania | AL | EU868 | EU868 | ✓ | +| Algeria | DZ | EU868 | EU868 | ✓ | +| American Samoa | AS | US915 | US915 | ✓ | +| Andorra | AD | EU868 | EU868 | ✓ | +| Angola | AO | EU868 | EU868 | ✓ | +| Anguilla | AI | AU915_SB1 | US915 and AS923 | ✓ | +| Antarctica - Chilean | AQ | - | | Check Helium Explorer | +| Antarctica - Australian | AQ | - | | Check Helium Explorer | +| Antarctica - British | AQ | - | | Check Helium Explorer | +| Antarctica - Argentine | AQ | - | | Check Helium Explorer | +| Antigua and Barbuda | AG | - | | Check Helium Explorer | +| Argentina | AR | AU915_SB1 | US915 and AS923 | ✓ | +| Armenia | AM | EU868 | EU868 | ✓ | +| Aruba | AW | - | | Check Helium Explorer | +| Australia | AU | AU915_SB2 | US915 and AS923 | ✓ | +| Austria | AT | EU868 | EU868 | ✓ | +| Azerbaijan | AZ | EU868 | EU868 | ✓ | + +## B + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------------|--------------|---------------|--------------------|---------------| +| Bahamas | BS | US915 | US915 | ✓ | +| Bahrain | BH | EU868 | EU868 | ✓ | +| Bangladesh | BD | AS923_1 | AS923 | ✓ | +| Barbados | BB | AU915_SB1 | US915 and AS923 | ✓ | +| Belarus | BY | EU868 | EU868 | ✓ | +| Belgium | BE | EU868 | EU868 | ✓ | +| Belize | BZ | AU915_SB1 | US915 and AS923 | ✓ | +| Benin | BJ | EU868 | EU868 | ✓ | +| Bermuda | BM | US915 | US915 | ✓ | +| Bhutan | BT | EU868 | EU868 | ✓ | +| Bolivia | BO | AS923_1 | US915 and AS923 | ✓ | +| Bonaire, Sint Eustatius & Saba | BQ | EU868 | EU868 | ✓ | +| Bosnia and Herzegovina | BA | EU868 | EU868 | ✓ | +| Botswana | BW | EU868 | EU868 | ✓ | +| Bouvet Island | BV | EU868 | EU868 | ✓ | +| Brazil | BR | AU915_SB2 | US915 and AS923 | ✓ | +| British Indian Ocean Territory | IO | - | | Check Helium Explorer | +| British Virgin Islands | VG | AU915_SB1 | US915 and AS923 | ✓ | +| Brunei | BN | AS923_1 | AS923 | ✓ | +| Bulgaria | BG | EU868 | EU868 | ✓ | +| Burkina Faso | BF | EU868 | EU868 | ✓ | +| Burundi | BI | EU868 | EU868 | ✓ | + +## C + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------------------------|--------------|---------------|--------------------|----------------| +| Cambodia | KH | AS923_1 | AS923 | ✓ | +| Cameroon | CM | EU433 | | Check Helium Explorer | +| Canada | CA | US915 | US915 | ✓ | +| Cape Verde | CV | EU868 | EU868 | ✓ | +| Cayman Islands | KY | US915 | US915 | ✓ | +| Central African Republic | CF | - | | Check Helium Explorer | +| Chad | TD | - | | Check Helium Explorer | +| Chile | CL | AU915_SB1 | US915 and AS923 | ✓ | +| China | CN | CN470 | | ✓ | +| Christmas Island | CX | AU915_SB2 | US915 and AS923 | ✓ | +| Cocos (Keeling) Islands | CC | AU915_SB2 | US915 and AS923 | ✓ | +| Colombia | CO | AU915_SB1 | US915 and AS923 | ✓ | +| Comoros | KM | EU868 | EU868 | ✓ | +| Congo (DRC) | CD | EU868 | EU868 | ✓ | +| Congo (Republic) | CG | - | | Check Helium Explorer | +| Cook Islands | CK | AS923_1 | US915 and AS923 | ✓ | +| Costa Rica | CR | AS923_1 | AS923 | ✓ | +| Côte d'Ivoire | CI | EU868 | EU868 | ✓ | +| Croatia | HR | EU868 | EU868 | ✓ | +| Cuba | CU | AS923_3 | US915 | ✓ | +| Curaçao | CW | AS923_1 | AS923 | ✓ | +| Cyprus | CY | EU868 | EU868 | ✓ | +| Czech Republic | CZ | EU868 | EU868 | ✓ | + +## D + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|---------------| +| Denmark | DK | EU868 | EU868 | ✓ | +| Djibouti | DJ | - | | Check Helium Explorer | +| Dominica | DM | AU915_SB1 | US915 and AS923 | ✓ | +| Dominican Republic | DO | AU915_SB1 | US915 and AS923 | ✓ | + +## E + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------------|--------------|---------------|--------------------|----------------| +| Ecuador | EC | AU915_SB1 | US915 and AS923 | ✓ | +| Egypt | EG | EU868 | EU868 | ✓ | +| El Salvador | SV | AU915_SB1 | US915 and AS923 | ✓ | +| Equatorial Guinea | GQ | EU868 | EU868 | ✓ | +| Eritrea | ER | - | | Check Helium Explorer | +| Estonia | EE | EU868 | EU868 | ✓ | +| Eswatini (Swaziland) | SZ | EU868* | EU868 | ✓ | +| Ethiopia | ET | - | | Check Helium Explorer | + +## F + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------------------------|--------------|---------------|--------------------|----------------| +| Falkland Islands | FK | EU868 | EU868 | ✓ | +| Faroe Islands | FO | EU868 | EU868 | ✓ | +| Fiji | FJ | EU868 | EU868 | ✓ | +| Finland | FI | EU868 | EU868 | ✓ | +| France | FR | EU868 | EU868 | ✓ | +| French Guiana | GF | EU868 | EU868 | ✓ | +| French Polynesia | PF | EU868 | EU868 | ✓ | +| French Southern Territories | TF | EU868 | EU868 | ✓ | + +## G + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------|--------------|---------------|--------------------|----------------| +| Gabon | GA | EU868 | EU868 | ✓ | +| Gambia | GM | EU433 | | Check Helium Explorer | +| Gaza Strip | PS | - | | Check Helium Explorer | +| Georgia | GE | EU868 | EU868 | ✓ | +| Germany | DE | EU868 | EU868 | ✓ | +| Ghana | GH | EU868 | EU868 | ✓ | +| Gibraltar | GI | EU868 | EU868 | ✓ | +| Greece | GR | EU868 | EU868 | ✓ | +| Greenland | GL | EU868 | EU868 | ✓ | +| Grenada | GD | AU915_SB1 | US915 and AS923 | ✓ | +| Guadeloupe | GP | EU868 | EU868 | ✓ | +| Guam | GU | US915 | US915 | ✓ | +| Guatemala | GT | AU915_SB1 | US915 and AS923 | ✓ | +| Guernsey | GG | EU868 | EU868 | ✓ | +| Guinea | GN | EU433 | | Check Helium Explorer | +| Guinea-Bissau | GW | - | | Check Helium Explorer | +| Guyana | GY | US915 | US915 | ✓ | + +## H + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-----------------------------------|--------------|---------------|--------------------|----------------| +| Haiti | HT | - | | Check Helium Explorer | +| Heard Island and McDonald Islands | HM | AU915_SB2 | US915 and AS923 | ✓ | +| Honduras | HN | AU915_SB1 | US915 and AS923 | ✓ | +| Hong Kong | HK | AS923_1 | AS923 | ✓ | +| Hungary | HU | EU868 | EU868 | ✓ | + +## I + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------|--------------|---------------|--------------------|-------| +| Iceland | IS | EU868 | EU868 | ✓ | +| India | IN | IN865 | | ✓ | +| Indonesia | ID | AS923_2 | AS923 | ✓ | +| Iran | IR | EU868 | EU868 | ✓ | +| Iraq | IQ | EU868 | EU868 | ✓ | +| Ireland | IE | EU868 | EU868 | ✓ | +| Isle of Man | IM | EU868 | EU868 | ✓ | +| Israel | IL | AS923_4 | | ✓ | +| Italy | IT | EU868 | EU868 | ✓ | + +## J + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|--------------------|--------| +| Jamaica | JM | AU915_SB1 | US915 and AS923 | ✓ | +| Japan | JP | AS923_1 | AS923 | ✓ | +| Jersey | JE | EU868 | EU868 | ✓ | +| Jordan | JO | EU868 | EU868 | ✓ | + +## K + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------|--------------|---------------|--------------------|----------------| +| Kazakhstan | KZ | IN865 | | ✓ | +| Kenya | KE | EU868 | EU868 | ✓ | +| Kiribati | KI | - | | Check Helium Explorer | +| Kosovo | XK | EU868 | EU868 | ✓ | +| Kuwait | KW | EU868 | EU868 | ✓ | +| Kyrgyzstan | KG | - | | Check Helium Explorer | + +## L + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------|--------------|---------------|--------------------|----------------| +| Laos | LA | AS923_1 | AS923 | ✓ | +| Latvia | LV | EU868 | EU868 | ✓ | +| Lebanon | LB | EU868 | EU868 | ✓ | +| Lesotho | LS | EU868* | EU868 | ✓ | +| Liberia | LR | - | | Check Helium Explorer | +| Libya | LY | AS923_3 | US915 | ✓ | +| Liechtenstein | LI | EU868 | EU868 | ✓ | +| Lithuania | LT | EU868 | EU868 | ✓ | +| Luxembourg | LU | EU868 | EU868 | ✓ | + +## M + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|----------------| +| Macau | MO | AS923_1 | AS923 | ✓ | +| North Macedonia | MK | EU868 | EU868 | ✓ | +| Madagascar | MG | EU868 | EU868 | ✓ | +| Malawi | MW | EU868* | EU868 | ✓ | +| Malaysia | MY | AS923_1 | AS923 | ✓ | +| Maldives | MV | EU868 | EU868 | ✓ | +| Mali | ML | EU433 | | Check Helium Explorer | +| Malta | MT | EU868 | EU868 | ✓ | +| Marshall Islands | MH | - | | Check Helium Explorer | +| Martinique | MQ | EU868 | EU868 | ✓ | +| Mauritania | MR | EU868 | EU868 | ✓ | +| Mauritius | MU | EU868 | EU868 | ✓ | +| Mayotte | YT | EU868 | EU868 | ✓ | +| Mexico | MX | US915 | US915 | ✓ | +| Micronesia | FM | - | | Check Helium Explorer | +| Moldova | MD | EU868 | EU868 | ✓ | +| Monaco | MC | EU868 | EU868 | ✓ | +| Mongolia | MN | - | | Check Helium Explorer | +| Montenegro | ME | EU868 | EU868 | ✓ | +| Montserrat | MS | AU915_SB1 | US915 and AS923 | ✓ | +| Morocco | MA | EU868 | EU868 | ✓ | +| Mozambique | MZ | EU868* | EU868 | ✓ | +| Myanmar | MM | AS923_1 | AS923 | ✓ | + +## N + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------|--------------|---------------|----------------------|----------------| +| Namibia | NA | EU868 | EU868 | ✓ | +| Nauru | NR | - | | Check Helium Explorer | +| Nepal | NP | IN865 | | ✓ | +| Netherlands | NL | EU868 | EU868 | ✓ | +| Netherlands Antilles | AN | EU868 | EU868 | ✓ | +| New Caledonia | NC | EU868 | EU868 | ✓ | +| New Zealand | NZ | AS923_1 | US915 and AS923 | ✓ | +| Nicaragua | NI | AU915_SB1 | US915 and AS923 | ✓ | +| Niger | NE | IN865 | | ✓ | +| Nigeria | NG | EU868 | EU868 | ✓ | +| Niue | NU | AS923_1 | US915 and AS923 | ✓ | +| Norfolk Island | NF | AU915_SB2 | US915 and AS923 | ✓ | +| North Korea | KP | - | | Check Helium Explorer | +| Northern Mariana Islands | MP | US915 | US915 | ✓ | +| Norway | NO | EU868 | EU868 | ✓ | + +## O + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|-------------|-------| +| Oman | OM | EU868 | EU868 | ✓ | + +## P + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------------|--------------|---------------|----------------------|----------------| +| Pakistan | PK | AS923_1 | AS923 | ✓ | +| Palau | PW | - | | Check Helium Explorer | +| Palestinian Territories | PS | - | | Check Helium Explorer | +| Panama | PA | AU915_SB1 | US915 and AS923 | ✓ | +| Papua New Guinea | PG | AS923_1 | US915 and AS923 | ✓ | +| Paraguay | PY | AU915_SB1 | US915 and AS923 | ✓ | +| Peru | PE | AU915_SB1 | US915 and AS923 | ✓ | +| Philippines | PH | AS923_3 | US915 | ✓ | +| Pitcairn Islands | PN | - | | Check Helium Explorer | +| Poland | PL | EU868 | EU868 | ✓ | +| Portugal | PT | EU868 | EU868 | ✓ | +| Puerto Rico | PR | US915 | US915 | ✓ | + +## Q + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------|--------------|---------------|-------------|-------| +| Qatar | QA | EU868 | EU868 | ✓ | + +## R + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------|--------------|---------------|--------------------|-------| +| Réunion | RE | EU868 | EU868 | ✓ | +| Romania | RO | EU868 | EU868 | ✓ | +| Russia | RU | RU864 | | ✓ | +| Rwanda | RW | EU868 | EU868 | ✓ | + +## S + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------------------------------------|--------------|---------------|----------------------|----------------| +| Sahrawi Arab Democratic Republic | EH | - | | Check Helium Explorer | +| Saint Barthelemy | BL | EU868 | EU868 | ✓ | +| Saint Helena | SH | - | | Check Helium Explorer | +| Saint Kitts and Nevis | KN | AU915_SB1 | US915 and AS923 | ✓ | +| Saint Lucia | LC | AU915_SB1 | US915 and AS923 | ✓ | +| Saint Martin | MF | EU868 | EU868 | ✓ | +| Saint Pierre and Miquelon | PM | EU868 | EU868 | ✓ | +| Saint Vincent and the Grenadines | VC | AU915_SB1 | US915 and AS923 | ✓ | +| Samoa | | EU868 | EU868 | ✓ | +| San Marino | SM | EU868 | EU868 | ✓ | +| São Tomé and Príncipe | ST | - | | Check Helium Explorer | +| Saudi Arabia | SA | EU868 | EU868 | ✓ | +| Senegal | SN | EU868 | EU868 | ✓ | +| Serbia | RS | EU868 | EU868 | ✓ | +| Seychelles | SC | EU433 | | Check Helium Explorer | +| Sierra Leone | SL | EU868 | EU868 | ✓ | +| Singapore | SG | AS923_1 | AS923 | ✓ | +| Slovakia | SK | EU868 | EU868 | ✓ | +| Slovenia | SI | EU868 | EU868 | ✓ | +| Solomon Islands | SB | AS923_1 | AS923 | ✓ | +| Somalia | SO | EU868 | EU868 | ✓ | +| South Africa | ZA | EU868 | EU868 | ✓ | +| South Georgia and the South Sandwich Islands | GS | EU868 | EU868 | ✓ | +| South Korea | KR | KR920 | | ✓ | +| South Sudan | SS | - | | Check Helium Explorer | +| Spain | ES | EU868 | EU868 | ✓ | +| Sri Lanka | LK | AS923_1 | AS923 | ✓ | +| Sudan | SD | - | | Check Helium Explorer | +| Suriname | SR | AU915_SB1 | US915 and AS923 | ✓ | +| Svalbard and Jan Mayen | SJ | EU868 | EU868 | ✓ | +| Sweden | SE | EU868 | EU868 | ✓ | +| Switzerland | CH | EU868 | EU868 | ✓ | +| Syria | SY | EU868 | EU868 | ✓ | + +## T + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|--------------------------|--------------|---------------|----------------------|----------------| +| Taiwan | TW | AS923_1 | AS923 | ✓ | +| Tajikistan | TJ | - | | Check Helium Explorer | +| Tanzania | TZ | AS923_1 | AS923 | ✓ | +| Thailand | TH | AS923_1 | AS923 | ✓ | +| Timor-Leste | TL | - | | Check Helium Explorer | +| Togo | TG | EU433 | | Check Helium Explorer | +| Tokelau | TK | AS923_1 | AS923 | ✓ | +| Tonga | TO | AU915_SB1 | US915 and AS923 | ✓ | +| Trinidad and Tobago | TT | AU915_SB1 | US915 and AS923 | ✓ | +| Tunisia | TN | EU868 | EU868 | ✓ | +| Turkey | TR | EU868 | EU868 | ✓ | +| Turkmenistan | TM | - | | Check Helium Explorer | +| Turks and Caicos Islands | TC | AU915_SB1 | US915 and AS923 | ✓ | +| Tuvalu | TV | - | | Check Helium Explorer | + +## U + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-----------------------------|--------------|---------------|--------------------|---------------| +| U.S. Minor Outlying Islands | UM | US915 | US915 | ✓ | +| U.S. Virgin Islands | VI | US915 | US915 | ✓ | +| Uganda | UG | EU868 | EU868 | ✓ | +| Ukraine | UA | EU868 | EU868 | ✓ | +| United Arab Emirates | AE | EU868 | EU868 | ✓ | +| United Kingdom | GB | EU868 | EU868 | ✓ | +| United States | US | US915 | US915 | ✓ | +| Uruguay | UY | AU915_SB1 | US915 and AS923 | ✓ | +| Uzbekistan | UZ | EU868 | EU868 | ✓ | + +## V + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|---------------------|--------------|---------------|--------------------|-------| +| Vanuatu | VU | AS923_3 | US915 | ✓ | +| Vatican City | VA | EU868 | EU868 | ✓ | +| Venezuela | VE | AS923_1 | AS923 | ✓ | +| Vietnam | VN | AS923_2 | AS923 | ✓ | +| Virgin Islands (UK) | VG | AU915_SB1 | US915 and AS923 | ✓ | + +## W + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|-------------------|--------------|---------------|--------------------|---------------| +| Wallis and Futuna | WF | EU868 | EU868 | ✓ | +| Western Sahara | EH | - | | Check Helium Explorer | + +## Y + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|------------|--------------|---------------|--------------------|---------------| +| Yemen | YE | - | | Check Helium Explorer | + +## Z + +| Country | Country Code | ISM Frequency | D1/M5/Pulse version | H1/H2 | +|----------|--------------|---------------|-------------|-------| +| Zambia | ZM | EU868 | EU868 | ✓ | +| Zimbabwe | ZW | EU868 | EU868 | ✓ | + +\* **Note for Eswatini, Lesotho, Malawi, and Mozambique:** TTN/CRASA references point toward EU863-870/EU433 for several SADC/CRASA countries, but the LoRaWAN regional parameters RP002-1.0.5 leave some of these blank or less explicit. We suggest using **EU868** for these countries, but recommend verifying with your local telecommunications regulatory body. + +:::info +Updated March 2025. +::: + +:::note +You can always contact us contact us through our [support](https://support.weatherxm.com) page for more information regarding devices without an exact frequency match to your country. +::: diff --git a/static/llms-pages/wxm-devices/helium/assemble.md b/static/llms-pages/wxm-devices/helium/assemble.md new file mode 100644 index 00000000..58030564 --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/assemble.md @@ -0,0 +1,122 @@ +# Assembling WS2000 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/assemble + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (not included) +2. Metal wrench (not included) +3. Batteries 1.5V **not rechargeable** (x6 AA) (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need six (x6) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Battery installation diagram (external box) + + + +- **Step 1:** Slide the battery box lock switch to unlock position. Push to open the battery box door according to the arrow direction. +- **Step 2:** Insert the 6 AA batteries according to the +/- polarity indicated. +- **Step 3:** Place and lock the battery box door. + + + +- **Step 4:** Unscrew the battery door at the bottom of the weather station. +- **Step 5:** Insert the dummy battery to the battery compartment, make sure the +/- polarity is correct. +- **Step 6:** Replace the battery door which comes along with the external battery box, then tighten the battery door screw. + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not trying to charge the batteries, but only provides power to an internal super capacitor, +thus no point using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the weather station. +::: + +Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + +The primary power source for the weather station is the solar panel. When solar power is available (sun light) a super capacitor is charged +and is later used during night and when there is insufficient solar light. +In climates that frequently sustain temperatures below 0°C or 32°F the use of lithium batteries is recommended +as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### LED of sensor working status + +At the bottom of the weather station there are buttons and indicators: + + + + Once the batteries are inserted, the LED indicator on the back of the station should turn on for 4 seconds + and then flash every 16 seconds indicating that the station transmits the data. + +
+ +### Adjust the solar panel + +The tilting angle of the solar panel can be adjusted vertically from 0° into 15°, 30°, 45° and 60° positions depending on the area you are living in. For optimal power output year-round, +please set the tilt angle that is closest to your latitude. + +
+ +Set tilt angle of solar panel related to your location + +| Location ( latitude, longitude) | Solar panel tilt angle | +| ----------------------- | ------------------------ | +| Hamburg (53.558, 9.7874) | 60° | +| Chicago (42.1146, -88.0464) | 45° | +| Houston (29.7711, -95.3552) | 30° | +| Bangkok (14.2752, 100.5684) | 15° | +| Sydney (-33.5738, 151.3053) * | 0° | + +***Sensors installed in southern hemisphere must have their solar panels flat to ensure maximum solar efficiency.** + +
+ +
+ +
+ + + +:::danger +If the screw holding the solar panel is not released for the adjustment, there is a risk of breaking the plastic enclosure. +::: +:::caution +Do not remove solar panel protection film before assemble battery box properly. +::: + +- **Step 1:** Remove the solar panel protection film. +- **Step 2:** Loosen the screw lightly until the gears on the opposite side separated from lock position. +- **Step 3:** Adjust the vertical angle of the solar panel (0°, 15°, 30°, 45°, 60°) according to the latitude of your location. +- **Step 4:** Push the gear and tighten the screw until the gears are securely locked. diff --git a/static/llms-pages/wxm-devices/helium/connect-and-claim.md b/static/llms-pages/wxm-devices/helium/connect-and-claim.md new file mode 100644 index 00000000..321af71a --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/connect-and-claim.md @@ -0,0 +1,121 @@ +# Connect and Claim the Station + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/connect-and-claim + +The weather station receives all meteorological data and presents it on the screen of your smartphone. +In this chapter, you will find guidance to set up the WeatherXM Helium station. + +## Prerequisites + +1. The station must be fully assembled (parts and batteries) +1. A working smartphone with connection to the internet +1. The [WeatherXM](/wxm-devices/helium/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +## Step by Step Instructions + +### Preparation of weather station + + + + Τo check if the weather station is in operation, check the red LED at the bottom of the station, it should light up - continuously or briefly - as soon as you insert the batteries. + + + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Choose the device type + +:::info +if you experience connection issues while claiming a helium device, make sure you are near the station. +::: + + + + +#### Reset your weather station and select device to pair + +Push the reset button at the bottom of your WeatherXM device to enable bluetooth pairing. This will expire in 5 minutes. After that, you will need to push it again to restart the pairing process. +After that, push the "Pair station via bluetooth" button as seen in the picture below. + +![select device to pair](/img/wxm-devices/helium/select-device-to-pair.png) + + +
+ +### Confirm station installation location + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your WeatherXM station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to acknowledge the correctness of the installation location and then tap on "Confirm and Proceed" button. + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you select the location that you will install your station as precisely as possible, as this will take part in the quality of the data you will share with the network and thus your overall WXM rewards. +::: + + +
+ +### Set weather station operation frequency + + + + +For the weather station to operate properly, you need to set its frequency to match the Helium network frequency in your country. + +[A list of the countries and their respective frequencies can be found here](https://docs.helium.com/iot/lorawan-region-plans/). + +Given the location of installation you defined in the previous step, we’ve selected the appropriate frequency for that location. + +Once you've found the right frequency, tap on the checkbox to acknowledge the correctness of the installation and then tap on "Set & Claim" button. +That's it. You've now claimed your new WeatherXM station and you'll be able to see its data on your WeatherXM apps! + +All you need to do now, is to update your weather station to the latest firmware version. To do so, please follow the instructions in the chapter ["Update Firmware"](/wxm-devices/helium/update-firmware/). + +:::caution +The frequency selected above is the correct one the country you’ve installed and will operate this station. +::: + + +
+ +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: diff --git a/static/llms-pages/wxm-devices/helium/contents.md b/static/llms-pages/wxm-devices/helium/contents.md new file mode 100644 index 00000000..3b12dd5f --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/contents.md @@ -0,0 +1,75 @@ +# Box Contents WeatherXM Helium Station (WS2000) + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/contents + +## Included + + + +

Included in the box

+
    +
  1. WeatherXM Helium weather station
    2. +
  2. External battery box
    3. +
  3. Metal zip ties
    4. +
+ + +:::info +Initial quantities included a short plastic pole accessory that was intended to be used with a wooden log to increase the total pole height to 2m. It was discovered that this accessory was not being utilised effectively, so it was removed from subsequent batches. +::: + +
+ +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x6 AA) +1. Metal mounting pole (recommended 40mm/1.57in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +### Weather Station + +The weather station is a set of sensors encased in a plastic shell that ensures the proper function of the device. + +The weather station is responsible for the collection of measurements of temperature, humidity, rain rate, wind speed, wind direction, atmospheric pressure and UV index. + + + +

Components

+ +
    +
  1. Rain gauge
    2. +
  2. Balance indicator
    3. +
  3. UV and light intensity sensor
    4. +
  4. Wind vane
    5. +
  5. Wind cups
    6. +
  6. Antenna
    7. +
  7. Solar panel
    8. +
  8. Radiation shield, temp/humidity, barometric pressure sensor
    9. +
  9. Drain holes
    10. +
  10. Built-in battery box
    11. +
  11. Red LED indicator
    12. +
  12. Config button
    13. +
  13. Mounting clamp
    14. +
  14. Adjustable hinge of solar panel
    15. +
  15. Tipping bucket
    16. +
  16. Rain sensor
    17. +
+ + +:::note +For further details about an advisable installation of the weather station, please see [Installing the WeatherXM Helium station (WS2000) Weather Station](/wxm-devices/helium/install-weather-station). +::: +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. diff --git a/static/llms-pages/wxm-devices/helium/install-weather-station.md b/static/llms-pages/wxm-devices/helium/install-weather-station.md new file mode 100644 index 00000000..7a27109d --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/install-weather-station.md @@ -0,0 +1,92 @@ +# Installing WS2000 Weather station + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/install-weather-station + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing [Best Practices for Proper Station Installation](/wxm-devices/helium/install-weather-station#best-practices-for-proper-station-installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + +## Best Practices for Proper Station Installation + +It is very important that your weather station collects quality measurements. +This turns the weather station into a powerful tool for yourself and WeatherXM. + +The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles +and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: + +:::info +Not sure of your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). +::: + +### Pole's Height +The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. +This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal +or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + + + + +
+ +### Tighten Pole +The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds. +This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements. + + + +
+ +### Installation Point + +The pole together with the weather station should be placed in an installation point, which: + +

1. Is away from heat sources

+Is not affected by the air or smoke flowing out of any chimney or ventilation system +(as an illustration, consider that wind of a certain direction may move warm smoke towards the station). +An advisable distance from a heat source is >5 meters/16.4ft. + +
+ +
+ +

2. Does not get in shadowed areas

+Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item). +
+ + + + +
+ +

3. Adequate Distance

+Has a distance from any obstacle around, which 2-4 times larger than the height of the highest obstacle +(e.g., if the highest obstacle around the installation point is a 6m/20ft tree, ht=6m/20ft, +and the pole of the weather station is 2m/6.56ft, hp=2m/6.56ft, then the pole should be placed at a distance (dp) of 8-16m/26-52ft, +2 x (ht-hp) < dp < 4 x (ht-hp). In case the pole is placed on a building’s roof, +then the building’s height should be added to the pole’s height). +Note that in cases of obstacles with a height >8m/26ft, you should consider placing the weather station +at a distance 30 times the width and 15 times the height of the obstacles around. + +:::note +All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible +while 3. is important for avoiding faulty precipitation and wind measurements. +::: + +
+ +### Direction Alignment + + + + Install the weather station in an open location with no obstructions above and around the + sensor for accurate rain and wind measurement. + Locate the North (N) marker on top of the weather station and align the marker to point North + upon final installation with a compass or GPS. Tighten the mounting bracket around a 30-40mm + or 1.1-1.57in diameter pole (not included) using the two screws and nuts provided. + Use the bubble level on the weather station to make sure the sensor is completely level for + proper measurement of precipitation, wind direction, UV and light intensity. diff --git a/static/llms-pages/wxm-devices/helium/introduction.md b/static/llms-pages/wxm-devices/helium/introduction.md new file mode 100644 index 00000000..b243aee7 --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/introduction.md @@ -0,0 +1,251 @@ +# Introduction WeatherXM Helium station (WS2000) + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/introduction + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 6 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to the Helium network and claim it as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Add your ERC20 compatible wallet + +In order to receive $WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WS2000 Weather Station (Helium) + + + + + +Powered via a small solar panel. +The maximum communication distance is 2 to 10km depending on the environment. + +- #### Air Temperature: + + - Range: -40.0 - 80.0 °C + - Accuracy: ±0.5 °C (0 - 80 °C) ±0.6 °C (-40 - 0 °C) + - Resolution: 0.1 °C + +- #### Air Humidity: + + - Range: 1 - 99% RH + - Accuracy: ±3% (1 - 90% RH) ±4% (90 - 99% RH) + - Resolution: 1% RH + +- #### Rain Hourly Rate: + + - Range: 0 - 450 mm/h + - Accuracy: ±7% + - Resolution: 0.254 mm/h + +- #### Barometric Pressure: + + - Range: 540 - 1100 hPa + - Accuracy: ±5 hPa(700 - 1100 hPa) ±8hPa (540 - 699 hPa) + - Resolution: 1 hPa + +- #### Wind Speed: + + - Range: 0 - 50.0 m/s + - Accuracy: ±0.5 m/s ({'<'}5 m/s) ±10% ({'>'}5 m/s) + - Resolution: 0.1 m/s + +- #### Wind Direction: + + - Range: 0 - 360° + - Accuracy: ± 8° + - Resolution: 1° + +- #### Light Intensity: + + - Range: 0 - 200000 lux + - Accuracy: ± 5% + - Resolution: 1 lux + +- #### UV Index: + + - Range: 0 - 16.0 + - Accuracy: ±10% + - Resolution: 0.1 + +

General Parameters

+ +- #### Operating Temperature: + - -20 to +60 °C (Use of alkaline batteries suggested) + - -40 to +60 °C (Lithium battery) + +- #### Operating Humidity: + + - 0 - 99% RH + +- #### Device Weight: + + - 1.5 kg + +- #### Certification: + + - CE / FCC / RoHS + +- #### Solar Panel: + + - 0.5W (When there is sunlight, solar panels will be used first, otherwise batteries will be used) + +- #### Battery Type: + + - AA size, 1.5 V batteries (alkaline or non-rechargeable Lithium battery) + +- #### Number of batteries: + + - External battery box: x6 AA batteries + +- #### Battery Life: + + - 1 year (solar panel with external battery box, 20 uplinks / hr) +- #### External Battery Box: + + - Support x6 AA 1.5V batteries + - Cable length: 2 m + - IP Rating: IPX6 + +##### * The battery life varies from data upload interval and distance between gateway. + + + + + +Powered via a small solar panel. +The maximum communication distance is 1.2 to 6.2 mi depending on the environment. + +- #### Air Temperature: + + - Range: -40.0 - 176.0 °F + - Accuracy: ±0.5 °F (0 - 176 °F) ±0.6 °F (-40 - 32 °F) + - Resolution: 0.1 °F + +- #### Air Humidity: + + - Range: 1 - 99% RH + - Accuracy: ±3% (1 - 90% RH) ±4% (90 - 99% RH) + - Resolution: 1% RH + +- #### Rain Hourly Rate: + + - Range: 0 - 17.7 in/h + - Accuracy: ±7% + - Resolution: 0.01 in/h + +- #### Barometric Pressure: + + - Range: 540 - 1100 hPa + - Accuracy: ±5 hPa(700 - 1100 hPa) ±8hPa (540 - 699 hPa) + - Resolution: 1 hPa + +- #### Wind Speed: + + - Range: 0 - 111.8 mph + - Accuracy: ±0.5 mph ({'<'}11.1mph) ±10% ({'>'}11.1 mph) + - Resolution: 0.1 mph + +- #### Wind Direction: + + - Range: 0 - 360° + - Accuracy: ± 8° + - Resolution: 1° + +- #### Light Intensity: + + - Range: 0 - 200000 lux + - Accuracy: ± 5% + - Resolution: 1 lux + +- #### UV Index: + + - Range: 0 - 16.0 + - Accuracy: ±10% + - Resolution: 0.1 + +

General Parameters

+ +- #### Operating Temperature: + - -4 to +140 °F (Use of alkaline batteries suggested) + - -4 to +140 °F (Lithium battery) + +- #### Operating Humidity: + + - 0 - 99% RH + +- #### Device Weight: + + - 3.3 lb + +- #### Certification: + + - CE / FCC / RoHS + +- #### Solar Panel: + + - 0.5W (When there is sunlight, solar panels will be used first, otherwise batteries will be used) + +- #### Battery Type: + + - AA size, 1.5V batteries (alkaline or non-rechargeable Lithium battery) + +- #### Number of batteries: + + - External battery box: x6 AA batteries + +- #### Battery Life: + + - 1 year (solar panel with external battery box, 20 uplinks / hr) + +- #### External Battery Box: + + - Support x6 AA 1.5V batteries + - Cable length: 6.5 ft + - IP Rating: IPX6 + +##### * The battery life varies from data upload interval and distance between gateway. + + + + diff --git a/static/llms-pages/wxm-devices/helium/maintenance.md b/static/llms-pages/wxm-devices/helium/maintenance.md new file mode 100644 index 00000000..21a48abf --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/maintenance.md @@ -0,0 +1,31 @@ +# Maintenance of WeatherXM Helium station (WS2000) + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/maintenance + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/helium/contents#weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: diff --git a/static/llms-pages/wxm-devices/helium/troubleshooting.md b/static/llms-pages/wxm-devices/helium/troubleshooting.md new file mode 100644 index 00000000..54775d8b --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/troubleshooting.md @@ -0,0 +1,129 @@ +# Troubleshooting of WeatherXM Helium station (WS2000) + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/troubleshooting + +:::info +**if you experience connection issues while claiming a WeatherXM Helium station, make sure you are near the station.** +::: + +### The updating process lasts forever + +If the process hangs and does not proceed or if pairing fails, try a [factory reset](/wxm-devices/helium/troubleshooting#factory-reset). + +
+ +### Asks to pair but fails + + + +Restart your station. Pairing is only allowed in the first 5 minutes after the station is started. After 5 minutes the station refuses pairing. If the problem persists, do a [factory reset](/wxm-devices/helium/troubleshooting#factory-reset) and try again. + +
+ +### No location (GPS) data + + + +If your station reports "No location data" please make sure your station is installed properly as per the installation instructions. + +:::note +Your station reports its location a few times per day depending on network and battery status and thus it might take some time until the location is confirmed by the WeatherXM platform. +::: + +
+ +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +
+ +### My station is not detected during scanning + + + + +Make sure the device has started. Press the reset button at the bottom of the weather station. The light at the bottom of the station will flash a few times indicating that the restart was successful. +If it continues to go undetected, try scanning again from a closer distance. The operating bluetooth range of the station is around 10m/32ft with few obstacles. + +
+ +### The process does not start or is stopped before it is completed + + + + +Close the application and start the process again. If the problem persists, press the reset button at the bottom of the weather station and try again. Finally, try doing a factory reset. + +
+ +### The app cannot connect to the station after successfully pairing + + + + If the claiming process is repeated more than twice without completion, attempt to unpair your weather station and start over. If you encounter connection problems during the claiming, make sure that you are near to the weather station at all times. The solution to the above is to visit the Bluetooth settings of the mobile phone, find the station in the paired devices and "forget the device". This flow is different on Android and iOS. + + +

How to forget/unpair your device

+ + + + + + + + + + + + + + + + + + + + +### Factory reset + + + +During factory reset all settings are reverted to the factory state, this includes the **frequency** configuration as well as the erasing of all **bonded mobile devices**. + +The erasing of the bonding information from the station results in the station "forgetting" all the mobile devices that have paired to it, so they will not be able to connect to the station anymore as they still hold old bonding data that is now outdated. In order to be able to pair with the station again **the station must be unpaired on the mobile device as well**, by removing it from the Bluetooth paired devices menu. + +:::warning +It is recommended to unpair the station from your mobile device's bluetooth menu, **right before** performing the factory reset. This ensures you’ll be able to successfully pair again after the reset, during which the station will reboot and remain in pairing mode for a few minutes. +::: + +After factory reset is complete and the station is paired to the mobile device again, the **frequency** needs to be set to the proper frequency used in your region via the station settings menu on your app or your station will not be able to join the network. + +To perform the factory reset, hold down the middle button on the bottom of the weather station, count to ~10 and release. The LED will start flashing very quickly as an indication that the factory reset has succeeded and then the station will restart. + +## Other Issues + +### How to see if there is Helium coverage in your area. + +You can check the Helium coverage in your location by either using [Hotspotty](https://app.hotspotty.net/hotspots/statistics) or [Helium's Explorer](https://explorer.helium.com/). + +
+ +### Can a WeatherXM Helium station paired with more than one device? + +Yes, it can be paired with multiple devices. + +
+ +### In order for the WeatherXM Helium stations to work, should they be in a Helium hexagon or the principle is the same as for the WiFi stations? + +WeatherXM Helium weather stations transmit data by using the helium network. In order to work properly they should be in a place where there is Helium coverage. + +
diff --git a/static/llms-pages/wxm-devices/helium/update-firmware.md b/static/llms-pages/wxm-devices/helium/update-firmware.md new file mode 100644 index 00000000..80f59571 --- /dev/null +++ b/static/llms-pages/wxm-devices/helium/update-firmware.md @@ -0,0 +1,62 @@ +# Update Firmware + +Canonical: https://docs.weatherxm.com/wxm-devices/helium/update-firmware + +### Prepare device for firmware update + +:::info +if you experience connection issues while claiming a WeatherXM helium device, make sure you are near the station. +::: + + + +In order for your station to keep operating normally and receive WXM rewards, you must update the station. + +The process is done wirelessly via bluetooth and requires you to be at a distance of ~{'<'}10m/32ft from the station. + +This document describes the firmware update process using an Android smartphone, the process for iOS is similar. + +Push the reset button at the bottom of your WeatherXM device to enable bluetooth pairing.This will expire in 5 minutes. After that, you will need to push it again to restart the pairing process. + +:::note +Your mobile phone must be paired to your weather station for the mobile app to be able to communicate with it. This procedure needs to take place only once. All further communications do not require any pairing as your weather station stays paired to your mobile phone as long as it was not factory reset or the pairing manually removed in your phone. +::: + +:::caution +Make sure you don't move away from your station as you might lose bluetooth connection. +::: + +
+ +### Installing update + + + + +:::info +if you experience connection issues while claiming a WeatherXM helium device, make sure you are near the station. +::: + +:::caution +**Do not switch off the application!** + +Make sure you don't move away from your station as you might lose bluetooth connection. +::: + + +
+ +### Successful firmware update + + + + +That's it! You've now claimed your new WeatherXM station and you'll be able to see its data on your WeatherXM app! + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: diff --git a/static/llms-pages/wxm-devices/installation-best-practices-ws100x.md b/static/llms-pages/wxm-devices/installation-best-practices-ws100x.md new file mode 100644 index 00000000..ee83686e --- /dev/null +++ b/static/llms-pages/wxm-devices/installation-best-practices-ws100x.md @@ -0,0 +1,80 @@ +# installation-best-practices-ws100x + +Canonical: https://docs.weatherxm.com/wxm-devices/installation-best-practices-ws100x + +## Best Practices for Proper Station Installation + +It is very important that your weather station collects quality measurements. +This turns the weather station into a powerful tool for yourself and WeatherXM. + +The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles +and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: + +:::info +Not sure of your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). +::: + +### Pole's Height +The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. +This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal +or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + + + + + + +
+ +### Pole specifications + + + The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft. + This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal + or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft. + +
+ +### Tighten Pole +The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds. +This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements. + + + +
+ +### Installation Point + +The pole together with the weather station should be placed in an installation point, which: + +

1. Is away from heat sources

+Is not affected by the air or smoke flowing out of any chimney or ventilation system +(as an illustration, consider that wind of a certain direction may move warm smoke towards the station). +An advisable distance from a heat source is >5 meters/16.4ft. + +
+ +
+ +

2. Does not get in shadowed areas

+Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item). +
+ + + + +
+ +

3. Adequate Distance

+Has a distance from any obstacles around, which 2-4 times larger than the height of the highest obstacle +(e.g., if the highest obstacle around the installation point is a 6m/20ft tree, ht=6m/20ft, +and the pole of the outdoor sensor is 2m/6.5ft, hp=2m/6.5ft, then the pole should be placed at a distance (dp) of 8-16m/26-52.5ft, +2 x (ht-hp) < dp < 4 x (ht-hp). In case the pole is placed on a building’s roof, +then the building’s height should be added to the pole’s height). +Note that in cases of obstacles with a height >8m/26ft, you should consider placing the outdoor sensor +at a distance 30 times the width and 15 times the height of the obstacles around. + +:::note +All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible +while 3. is important for avoiding faulty precipitation and wind measurements. +::: diff --git a/static/llms-pages/wxm-devices/m5/assemble.md b/static/llms-pages/wxm-devices/m5/assemble.md new file mode 100644 index 00000000..80134f3b --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/assemble.md @@ -0,0 +1,101 @@ +# Assembling WS1000 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/assemble + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) + and another that measures the wind direction (though wind vane). + Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, + which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. + The wind vane should be placed on the shaft at the bottom of the sensor. + After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 20 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG1000 gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: +
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). + +
diff --git a/static/llms-pages/wxm-devices/m5/connect-and-claim.md b/static/llms-pages/wxm-devices/m5/connect-and-claim.md new file mode 100644 index 00000000..c625e57d --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/connect-and-claim.md @@ -0,0 +1,251 @@ +# Connect and Claim the Gateway + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/connect-and-claim + +## WG1000 Gateway + + + + + + + + + +The weather station comes together with the WG1000 Gateway. +The WG1000 Gateway receives all the meteorological data, which are measured and transmitted every 16 seconds by the outdoor sensor +and displays them on its screen. + +In this chapter, you will find guidance to set up the WG1000 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. The [WeatherXM](//wxm-devices/m5/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +1. A reliable 2.4 GHz WiFi network (5 GHz is not supported) for the WG1000 Gateway to connect to. + +
+ +## Step by Step Instructions + +### Connect GPS antenna + + + + Attach the GPS antenna to WG1000 Gateway. You should hear a "click" when it's properly installed. + + +
+ +### Connect M5 Gateway to power source and turn device on + + + + The WG1000 Gateway must be connected to a power source at all times. + It has a limited battery, but you should not rely on it. + + +:::caution +If WG1000 Gateway turns off, you will not receive $WXM rewards, as you will not be able to share data with the WeatherXM network. **This will result in no WXM rewards!** +::: + + +
+ +### Place WG1000 Gateway near a window (for better GPS signal) + + + +For better GPS signal, it's highly recommended to place the WG1000 Gateway device near a window. Make sure that it has a good GPS coverage at all times. + +:::note +This step could take some time till the device connects to GPS satellites. +::: + +:::caution +If the GPS signal is lost, you could receive less WXM rewards (or none). This is because we will not be able to verify your location. +::: + + +
+ +### Change Frequency (Optional) + + + + + + + + + + + + +The WG1000 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 2 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency + + + + +
    +
  1. Swipe right on the touch screen
    2. +
  2. Click the Frequency options and select the new frequency your WG1000 Gateway will listen to
    3. +
  3. A confirmation dialog will open. Read it carefully and click "Continue" or "Cancel" accordingly
    4. + +
+ + + +
    +
  1. Swipe left on the touch screen
    2. +
  2. Click the Frequency options and select the new frequency your WG1000 Gateway will listen to
    3. +
  3. A confirmation dialog will open. Read it carefully and click "Yes" or "No" accordingly
    4. +
+ + + +:::caution +If you don't use the correct frequency as your weather station, WG1000 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Connect WG1000 Gateway to WiFi + + + + + +By now, your WG1000 Gateway is set and ready for claiming! +- Swipe right to navigate to the settings screen. There, tap on "Configure WiFi" to switch to connect mode. +- An Access Point will be created with SSID "WXMMinerM5", you should connect to it from your smartphone. +- Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +- Enter your WiFi credentials and click "Save" +- WG1000 Gateway will restart and connect to your WiFi network + +A popup will open, asking you to select the desired network you'd like to connect the WG1000 Gateway. Select the one you want and provide the password for it. + + + + +By now, your WG1000 Gateway is set and ready for claiming! +- Swipe right to navigate to the settings screen. There, tap on "Configure WiFi" to switch to connect mode. +- An Access Point will be created with SSID "WXMMinerM5", you should connect to it from your smartphone. +- Once connected, a popup will appear on your smartphone to enter your WiFi credentials. +- Enter your WiFi credentials and click "Save" +- WG1000 Gateway will restart and connect to your WiFi network + +A popup will open, asking you to select the desired network you'd like to connect the WG1000 Gateway. Select the one you want and provide the password for it. + + + +:::note +Once the WiFi credentials have been successfully transferred to WG1000 Gateway, the device will restart and the WiFi icon will turn green! +::: +:::note +While you are connected to the "WXMMinerM5" network, you will not have internet access. +::: + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### How to properly configure your WG1000 Gateway's WiFi network step by step (Video) + + + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Type the WG1000 Gateway serial number when prompted + + + + +#### Navigate to WG1000 Gateway and find the device's Serial Number + +Follow the steps shown in the image below to find your WG1000 Gateway's Serial Number. You'll need to type this in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + + + + + + + + + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: diff --git a/static/llms-pages/wxm-devices/m5/contents.md b/static/llms-pages/wxm-devices/m5/contents.md new file mode 100644 index 00000000..f6f5c345 --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/contents.md @@ -0,0 +1,103 @@ +# Box Contents of M5 bundle (WB1000) + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/contents + +## Included + + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Metal plate
    5. +
  5. U-bolts (x2)
    6. +
  6. Nuts (x4)
    7. +
  7. Wrench
    8. +
  8. Screwdriver
    9. +
  9. Allen key
    10. +
  10. WG1000 Gateway
    11. +
  11. External RF Antenna
    12. +
  12. Reset jumper (not included in very early models)
    13. +
  13. GPS antenna
    14. +
  14. Power supply cable (USB-C)
    15. +
+ + +:::danger +The reset jumper (#12 above) is used for recovery purposes and troubleshooting. Do not connect it to your WG1000 Gateway unless instructed by support or you know what you're doing. +Using it without proper reason may result in loss of data which will affect your rewards. +::: + +
+ +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole +1. USB power supply + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 16 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1000 Weather Station](/wxm-devices/m5/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG1000 Gateway + + + +The WG1000 Gateway is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via WiFi to IPFS and the WeatherXM network. + +The WG1000 Gateway is advised to be placed indoors, in an environment of relatively constant temperature (ideally within a daily range of <4°C/7°F for proper functioning of the barometer), +near a window (for better GPS signal). + +The WG1000 Gateway should be permanently connected to power and powered on in order to be able to receive, record and upload measurements to the Internet. + +The above graph shows the location of the buttons and the needed connections. Briefly, there is a power and a reset button, a port for the GPS antenna and a USB Type-C port for power supply. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. diff --git a/static/llms-pages/wxm-devices/m5/install-weather-station.md b/static/llms-pages/wxm-devices/m5/install-weather-station.md new file mode 100644 index 00000000..96417222 --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/install-weather-station.md @@ -0,0 +1,35 @@ +# Installing WS1000 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/install-weather-station + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +### Video Instructions with Dr. Keppas + +[![Instruction on how to install the WG1000 Gateway WeatherXM weather station](/img/wxm-devices/m5/video-setup-installation.png)](https://www.youtube.com/watch?v=J-dSXNLX4nk&ab_channel=WeatherXM) + +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ Thus, it is important that you are able to read all the measurements on the WG1000 Gateway's screen, + while you keep the outdoor sensor nearby (preferably not closer than 1.5m/5ft from the WG1000 Gateway though).
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. diff --git a/static/llms-pages/wxm-devices/m5/introduction.md b/static/llms-pages/wxm-devices/m5/introduction.md new file mode 100644 index 00000000..c2a79308 --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/introduction.md @@ -0,0 +1,159 @@ +# Introduction of M5 bundle (WB1000) + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/introduction + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG1000 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive $WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG1000 Gateway + +- Capacitive touch screen +- ATECC608 hardware encryption +- GPS + BLE + RF +- Forwards weather data via WiFi +- Powered by USB +- Over-the-air firmware upgradable + +### WS1000 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG1000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1000 Gateway is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 16 seconds + + + + + +Powered via a small solar panel and batteries and communicates with the WG1000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG1000 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - Reporting Interval: 16 seconds + + + + diff --git a/static/llms-pages/wxm-devices/m5/maintenance.md b/static/llms-pages/wxm-devices/m5/maintenance.md new file mode 100644 index 00000000..776c6275 --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/maintenance.md @@ -0,0 +1,33 @@ +# Maintenance of WS1000 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/maintenance + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG1000 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/m5/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: diff --git a/static/llms-pages/wxm-devices/m5/troubleshooting.md b/static/llms-pages/wxm-devices/m5/troubleshooting.md new file mode 100644 index 00000000..9c03b22e --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/troubleshooting.md @@ -0,0 +1,207 @@ +# Troubleshooting of M5 bundle (WB1000) + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/troubleshooting + +## Weather Station + +### Weather station not reporting data to WG1000 Gateway. There are dashes (--) on the display console. + +First make sure you WG1000 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/m5/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/m5/contents#outdoor-weather-station)) for flashing. +The LED should flash every 16 seconds. + +If the LED is not flashing every 16 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors, or the WG1000 gateway has not been reset. +The solution may be as simple as powering down and up the WG1000 Gateway. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG1000 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. +1. WG1000 Gateway should display all the observations measured by the weather station. +1. Try to place the WG1000 Gateway at the desirable point and check that it receives data. + Ensure the power adapter if used is not too close to the WG1000 Gateway and the WG1000 Gateway is not close to other electrical noise generating devices + such as TVs, monitors, computers and transmitting devices. +1. If you still have intermittent problems, move the weather station and the WG1000 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft if you use the internal (external) RF antenna. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG1000 Gateway. + Relocate the weather station and WG1000 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. +1. Use the external RF antenna provided with M5, but this requires you open the WG1000 Gateway (Read more on the bottom of this page). + +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by (see [Best Practices for Proper Station Installation](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation)). + +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +### One or more variables are extremely high, low, or constant for long periods of time. + +Change the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +### Pressure on WG1000 Gateway appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +## WiFi Connectivity + +### No WiFi connection + +Check for the WiFi symbol on the top-right corner of the display. + +- If wireless connectivity is operational, the WiFi icon will appear in green. +- If the symbol appears in red, but you do remember configuring it successfully before, check that the WG1000 Gateway and Internet router are close enough. + +If you have never been able to configure WiFi to a working state, make sure your WiFi supports 2.4 GHz signals. The console does not support WiFi that uses the 5 GHz spectrum. + +Make sure you configured the correct SSID and password. Repeat the procedure if necessary to verify. + +
+ +### Wifi Repeater +Usually, using a WiFi repeater is not an issue, but in some cases it may affect your WG1000 Gateway’s connection. If you are experiencing issues with your M5, try to connect it directly to your router and see if the problem persists. If it does not, +then the issue is with the repeater. If it does, please contact us through [support](https://support.weatherxm.com). + +
+ +### WG1000 Gateway not working in 5 GHz WiFi. +WG1000 Gateway is designed to work **only** at the 2.4GHz frequency. Please make sure the 2.4Ghz band on your router is enabled. If you are still experiencing issues, please contact us through [support](https://support.weatherxm.com). + +
+ +### I don't see the Wi-Fi name "WXM MinerM5" for initial setup on the app. + +It might take some time and attempts for it to connect. Please make sure that your Wi-Fi supports 2.4 GHz signals. You may also need to try from a different phone. You can also watch our instructional [video](https://www.youtube.com/watch?v=sUJEwuFq1CE). + +
+ +## GPS Location + +### No location (GPS) data (Arrow icon is red) +If the GPS (arrow) icon on your M5's UI is red, it means that there is no GPS signal: + + + + + + + + + + +Make sure your GPS antenna is firmly connected to the right connector: + +And then proceed to the following steps: + +1. Move your WG1000 Gateway outdoors (with the GPS antenna connected) + for a couple of minutes until the GPS icons becomes green. +1. Then, move WG1000 Gateway indoors placing the GPS antenna next to a window. + +If the problem remains, make sure the external antenna is selected in your M5's GPS stack (Read more on the bottom of this page). + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## My Station does not connect to the WG1000 Gateway + + [![Instruction on how to switch to RF antenna](/img/wxm-devices/m5/m5-video-lorawan.png)](https://www.youtube.com/watch?v=FP4rT3FTz0M&) + + +If the installation of the station and the placement of the WG1000 Gateway is more than 50m/~160ft apart, you must install the RF antenna so that the two can communicate over such distance. +Please follow the instructions below, or in the video. + +:::caution +If the station and WG1000 Gateway are more than 50m/164ft apart, you must install the RF antenna. Else the station might not be able to properly communicate with WG1000 gateway, resulting in less to none data being shared to the network, and thus reduce WXM rewards. +::: + +
+ +WG1000 Gateway RF Antenna Installation Instructions + +#### WG1000 Gateway Antenna Troubleshooting + +WG1000 Gateway is equipped with two antennas, the GPS and the RF. The GPS antenna is used to determine the location (coordinates) and altitude of the weather station, +while the RF antenna is responsible for the communication between the WG1000 Gateway and the weather station. + +On the left side of the WG1000 Gateway you may notice that there are two different caps, a grey for GPS and a blue for RF (labeled as "LoRa" in the cap). +Each of these caps contains a system relevant to the antennas mentioned above. + +By default, the external GPS antenna and the internal RF antenna are connected, and there is no need to modify this. + +The antenna plugs are VERY SENSITIVE so it is NOT recommended to switch cables unless there is a serious problem. + +#### Switch external/internal GPS antenna + +The WG1000 Gateway uses by default the external GPS antenna, which should be connected to the port on the grey GPS cap, +In case you desire to change the internal/external GPS antenna, follow the following steps: + +1. Unscrew and remove the four screws behind the WG1000 Gateway. +1. Remove the first cap. You may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. You will notice two small cables, one coming from the port on the side and one coming from a small chip. + Remove the cable, which is connected to a specific reception on the green board and connect the desired cable to the same reception. +1. Clasp the cap back and screw the device. +1. In case you changed to the external GPS antenna, connect the external antenna to the corresponding port on the side of the WG1000 Gateway. + +#### Switch external/internal RF antenna + +The WG1000 Gateway beta v1 uses by default the internal RF antenna. +In case you desire to change the internal/external RF antenna, follow the following steps: + +1. Unscrew and remove the four screws behind the WG1000 Gateway. +1. Remove the first cap. You may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. Remove the grey GPS cap. Again you may use a flat-head screwdriver to separate the cap from the rest of the WG1000 Gateway. +1. You will notice two small cables, one coming from the port on the side and one coming from an edge of the green board. + Remove the cable, which is connected to a specific reception on the green board and + connect the desired cable to the same reception. +1. Clasp the caps and the cap back and screw the device. +1. In case you changed to external RF antenna, connect the external antenna to the corresponding port on the side of the WG1000 Gateway (LoRa cap). + +##### Internal parts of the WG1000 Gateway + +a. Bottom is the first cap you remove once the WG1000 Gateway is unscrewed. + +b. The second cap in grey is the GPS + +c. The third cap in blue is the RF Connection to the weather station + +d. Top cap in white is the rest of WG1000 Gateway. + + + +
+ +## Other Issues + +### My WG1000 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### What can I do if my WG1000 Gateway is switching off frequently? + +Please disconnect the WG1000 Gateway from the power source, let it turn off by itself and reconnect it after 15-20 minutes. You can also try using a different USB cable and another wall adapter. If none of the previous work, try removing the four screws of the M5 bundle, separate the stacks and tighten the screws again. + +
+ +### Why is my station showing offline? + +Assuming that the WG1000 Gateway unit is powered on, this may be due to a bad internet connection or bad RF connection between the WG1000 Gateway and the outdoor station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: diff --git a/static/llms-pages/wxm-devices/m5/usb-flasher.md b/static/llms-pages/wxm-devices/m5/usb-flasher.md new file mode 100644 index 00000000..b78bac40 --- /dev/null +++ b/static/llms-pages/wxm-devices/m5/usb-flasher.md @@ -0,0 +1,109 @@ +# Updating Your WXM-M5 Firmware with the Flasher Tool + +Canonical: https://docs.weatherxm.com/wxm-devices/m5/usb-flasher + +

Introduction

+If you are currently using a WG1000 Gateway with firmware version 0.3.12, it's essential to update your device using the Flasher Tool. This version is considered obsolete and cannot receive updates through the "Over The Air" (OTA) method any longer due to significant differences in the underlying operating system. To ensure your WXM-M5 continues to operate efficiently and receive rewards, you must perform a full firmware flash using a USB cable. +This guide will walk you through the step-by-step process of updating your WG1000 Gateway to the latest firmware version, ensuring you stay up to date with the latest features, security enhancements and continue to receive rewards. + +:::tip +To check the version of your WXM-M5, swipe to the left-most screen (about). If your version is newer than 0.3.12 you do not need to proceed with this update as your device will receive updates automatically. +::: + +:::danger +Support for WG1000 Gateway devices running v0.3.12 will be discontinued from November 2023 and they will cease to receive rewards shortly thereafter. It is important to follow the instructions on this page to update your device. +::: + +

How to Update Your WG1000 Gateway

+Follow these instructions carefully to update your WG1000 Gateway's firmware using the Flasher Tool. We've included screenshots to help you navigate the process. +Step 1: Prepare Your Equipment +Before starting, ensure you have the following: +
    +
  • A WG1000 Gateway powered on, running firmware version 0.3.12
    • +
  • A USB Type-C cable to connect your WG1000 Gateway to your computer
    • +
  • A computer running the Flasher Tool
    • +
+ +Step 2: Launch the Flasher Tool + + ![Launch Flasher Tool](image) + +
    +
  1. Download and install the Flasher Tool for your OS
    2. + Under Assets select: +
    1. Windows: `weatherxm_m5_flasher_*.exe`
      2. +
    2. Linux: `weatherxm_m5_flasher_*.deb`
    +
  2. Open the Flasher Tool on your computer
    3. +
+ +:::tip +If any device is found under the Serial port, temporarily unplug it before continuing. +::: + + +Step 3: Connect your WG1000 Gateway + + ![Connect Your WXM-M5](image) +
    +
  1. Plug one end of the USB cable into your computer's USB port
    2. +
  2. Plug the other end of the USB cable into your WXM-M5. If your WG1000 Gateway was off, it will turn on automatically.
    3. +
+ +Step 4: Select your WG1000 Gateway + + ![Select Your WXM-M5](image) + + In the Flasher Tool under "serial port", you can see all the devices connected to the virtual serial ports on your computer. Confirm that the port of your WG1000 Gateway is selected. Usually the device with the largest suffix number is the one that was connected more recently. + +:::note +Serial port name may differ depending on your OS. +::: + + +Step 5: Start the Update Process + + ![Start the Update Process](image) + +
    +
  1. Double-check that your WG1000 Gateway is connected to your computer via USB
    2. +
  2. Click on the "Update" button in the Flasher Tool
    3. +
+ +:::danger +Do not disconnect the USB cable until the update is successfully completed +::: + + +Step 6: Wait for Completion +The Flasher Tool will now update your WXM-M5's firmware. Please wait patiently for the process to finish. + +:::danger +Do not disconnect the USB cable until the update is successfully completed +::: + +Step 7: Verify the Update +Once the update is complete, your WG1000 Gateway will restart automatically. You can verify the successful update by checking the firmware version on the WXM-M5's screen. + +:::note +If your WG1000 Gateway did not restart automatically, press and hold the power button until it turns off and then power it back on. +::: +

Troubleshooting

+

Windows

+The flasher tool runs on Windows 10/11. Windows 7 is not supported. +When you run the tool, you will be greeted by the "Windows prevented an unrecognised application from running.". This is because the binary is not signed. Click More Info > Run Anyway to proceed. +

When I connect my WG1000 Gateway no ports appear.

+First, check if your USB cable is not damaged. It is recommended to try another cable to get this out of the way. If your WG1000 Gateway still doesn't appear in the port list, open Device Manager and check under "Ports (COM & LPT)". If no devices appear in the list your cable is most likely damaged. If a device with an exclamation mark appears or is in any other kind of erroneous state, your computer most likely lacks the USB drivers. Download and install the drivers from the USB chip manufacturers' website. +

I get an error about VCRUNTIMEXXX.dll missing

+Your windows installation is missing the MSVC runtime libraries. Download and install them from Microsoft's website. It is recommended to install both the x86 and x64 versions. + +

Linux

+Tested only on Debian based distributions. +If you encounter issues during the flashing process, follow these steps: +
    +
  1. If flashing fails immediately after pressing the "update" button, it may be due to insufficient privileges to access the serial port. In Debian-based distributions, run the following command to add your user to the appropriate group: +sudo adduser $USER dialout +After running this command, log out and then log back in, and retry the update process. If the issue persists, try running the Flasher Tool with sudo: +sudo /opt/wxm_m5_flasher/run.sh
    2. +
+If you have any further questions or encounter any issues during the update process, don't hesitate to reach out to our support team for assistance. We are here to help you keep your WG1000 Gateway up to date and running smoothly.

+ Be sure to include the contents of your log file for further analysis. To access the log file, click "Log" in the top right corner of the Flasher Tool window. diff --git a/static/llms-pages/wxm-devices/pulse/assemble.md b/static/llms-pages/wxm-devices/pulse/assemble.md new file mode 100644 index 00000000..d0289364 --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/assemble.md @@ -0,0 +1,172 @@ +# Assembling WS1001 Weather Station + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/assemble + +Setting up the weather station is a process of several steps in order to make this system work properly +and measure weather conditions as accurately as possible. + +## Prerequisites for proper assembly + +1. Screwdriver (included) +1. Metal wrench (included) +1. Batteries, x2 AA **not rechargeable** (not included) + +:::danger +If you use rechargeable batteries, you may harm your device. +::: + +:::caution +In order to properly deploy the weather station, you will need two (2) AA batteries. These are not included in the box. +::: + +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +## Step by step instructions + +### Assembling the wind sensor + + + +:::caution +Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor. +::: + + + +The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly) +and another that measures the wind direction (though wind vane). +Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor, +which is on the opposite side of the rain collector. Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. +The wind vane should be placed on the shaft at the bottom of the sensor. +After pushing each of the parts, tighten the set screw with a Phillips screwdriver (size PH0). + +:::note +Both parts should rotate freely. There should be no noticeable friction when the wind cup assembly rotates. +However, the wind vane’s movement has a small amount of friction, which assists in providing steady wind direction measurements. +::: + +
+ +### Installing batteries + + +
+ + Use a screwdriver to open the battery compartment and insert 2 AA batteries. + Once the batteries are inserted, the LED indicator on the back of the sensor should turn on for 4 seconds + and then flash every 16 seconds indicating that the sensor transmits the data. + Note that the LED flashing only indicates the transmission of the data from the outdoor sensor + and it does not assure the reception of the data by the WG3000 Gateway. + Although alkaline batteries are sufficient for most climates, lithium non-rechargeable batteries could be used for cold weather climates. + The primary power source for the outdoor sensor is the solar panel. When solar power is available, a super capacitor is charged + and is later used during night and when there is insufficient solar light. + In climates that frequently sustain temperatures below 0°C (or 32°F) the use of lithium batteries is recommended + as these are performing better than alkaline batteries under such circumstances, but depend on battery manufacturer and quality. +
+ +:::warning +Using old and new batteries together, especially low-quality ones or used, increases fire risk. For safety, use high-quality batteries of the same age and type. +::: + +:::danger +**Rechargeable batteries should not be used**, as they provide lower voltages and lose power over time. +Solar panel is not used for charging the batteries, but only provides power to an internal super capacitor, +thus no point in using rechargeable ones. +::: + +:::danger +Batteries should not be installed backwards. This may permanently damage the outdoor sensor. +::: +
+ +### External Battery pack installation + +While not mandatory, we strongly recommend the installation of the battery pack for the following reasons: + + 1. Extended Battery Life: Utilising only two batteries will result in the station depleting its power within 3 to 5 months, depending on environmental conditions. Installing the battery pack increases the battery life by approximately four times, significantly reducing the frequency of battery replacements. + 2. Improved Accessibility: The battery pack includes an extension cable (~3 meters), providing easier access for battery replacement when needed. + + + + 1. Open the Battery Pack: Begin by pulling the clip on the side of the battery pack to open it. + 2. Access the Battery Base: Gently pull out the battery base. You will see eight battery sockets arranged in groups of two (two pairs in the front and two in the back). + 3. Insert the Batteries: Place a battery in each socket, ensuring correct polarity alignment. + 4. Reassemble the Battery Pack: Carefully place the battery holders back into their original positions, ensuring they are oriented correctly (i.e., the cable should remain at the bottom and should not be twisted). + 5. Secure the Battery Pack: Close the lid of the battery pack and push the clip until it clicks into place. + 6. Prepare the Weather Station: On the weather station, remove the battery cover. + 7. Insert Dummy Batteries: Insert the dummy batteries into the station as you would with regular batteries, ensuring correct polarity. + 8. Close the Weather Station Cover: Close the embedded lid on the weather station and fasten the screw securely. + 9. Mount the Battery Pack: The battery pack can be attached to a pole using the two provided zip ties. + +:::caution +If the dummy battery is not installed in the correct orientation, no power will be provided and the LED indicator will not be flashing. +::: + +:::note +In case that LED is permanently on or does not light up at all, +make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Remove Sticker from Solar Panel + + + + + Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off. + + +:::note +In case that LED is permanently on or does not light up at all,make sure that the batteries are inserted fully and in the correct way. +::: + +
+ +### Installing Bird Spikes +The bird spikes are designed to be installed on the rim of the rain cup to deter birds from perching on or around +the rain cup. + +#### Included Components + +Each weather station comes with the following bird spike components: + +- Metal Spikes +- Rim-Mounted Spike Holders: These are designed to fit around the edge of the rain cup. +- Metal Zip Ties: Two metal zip ties are included. Only one is required for installation; the second is provided as a spare. + +#### Installation Instructions + + 1. Prepare the Spike Holders: Insert a metal zip tie through each spike holder, ensuring that the holes are facing upward. + 2. Insert the Spikes: Place a metal spike into each hole on the spike holder. + + + + 3. Attach the Spike Holders to the Rain Cup: Wrap the zip tie around the rim of the rain cup and tighten it securely to prevent the spike holders from loosening or falling off. For easier installation, + it is recommended to first remove the rain cup by twisting it lightly before attaching the spike holders. + + + + 4. Secure the Metal Zip Tie: Carefully secure the metal zip tie on top of the rain cup to ensure the spike holders are firmly in place and will not fall off. + + + + 5. Place the spikes, short side down, in the designated spots on the ring. The final setup should match the image below. + + + +
+ +### Installing U-bolts and metal plate + + + +#### U-bracket installation + +The U-bolts and the metal plate are used to support the mounting of the outdoor sensor on a pole. +The straight edge of the metal plate is inserted in the groove at the bottom of the unit (at the opposite side of the solar panel). +The curved part of the 90-degree angle bent edge of the metal plate should be oriented to the wind sensor in order to “hug” the mounting pole. +After inserting the metal plate, the U-bolts should be inserted through the respective holes of the metal plate. +Loosely screw the nuts on the ends of the U-bolts. They will be tightened later when mounting on the pole (see [Mounting the outdoor sensor](/wxm-devices/m5/install-weather-station#mounting-the-outdoor-sensor)). diff --git a/static/llms-pages/wxm-devices/pulse/connect-and-claim.md b/static/llms-pages/wxm-devices/pulse/connect-and-claim.md new file mode 100644 index 00000000..afcd8bb0 --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/connect-and-claim.md @@ -0,0 +1,159 @@ +# Connect and Claim the Gateway + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/connect-and-claim + +## WG3000 Gateway + +The weather station comes together with the WG3000 Gateway. +The WG3000 Gateway receives all the meteorological data plus the location of the weather station, and forwards it to the WeatherXM network via cellular networks. +In this chapter, you will find guidance to set up the WG3000 Gateway. +
+ +## Prerequisites + +1. The station must be fully assembled (parts and batteries). +1. A working smartphone with connection to the internet. +1. The [WeatherXM](/wxm-devices/pulse/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. + +
+ +## Step by Step Instructions + +### Connect WG3000 Gateway to power source and turn the gateway on + +The WG3000 Gateway must be placed on a sunny surface, facing south, and with no obstacles in front of it. + +
+ +### Change Frequency (Optional) + + + +The WG3000 Gateway's frequency must be set to match the frequency of your weather station so it can listen for the weather data it transmits. There are 3 frequencies available: +- Model A: 868 MHz (default) +- Model B: 915 MHz +- Model C: 923 MHz + +:::note +**If your weather station is 868 MHz, you don't need to change anything as it is configured to this value by default.** +If unsure, check the sticker under the station or the box that came in it. +::: + + +### Steps to change the frequency +1. Navigate to the "Device Settings" menu by pressing the arrow keys on your WG3000 Gateway. + + + +2. Click the Frequency options and select the new frequency your WG3000 Gateway will listen to. + + + +3. Select the new frequency by pressing the "OK" button. + + + + +4. The Gateway will now reboot to accept the new frequency. + +:::caution +If you don't use the correct frequency as your weather station, WG3000 Gateway will not be able to communicate with your weather station, thus you will not send any weather data and receive any $WXM rewards! +::: + +
+ +### Download WeatherXM app and login + + + + + + + Download our WeatherXM apps from their respective app store. Once you have your WeatherXM app, login to your account (you have to create a new WeatherXM account). + +
+ +### Tap the "+" button + + + +

Start the Claiming Process

+ + Once you've logged in to your WeatherXM app, you will see an empty device list (assuming this is your first station setup). At the bottom right corner, you will see a "+" button. Tap it to start the claiming process of your station. Once you've done this, you'll be able to view all data of this station. + + + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + +
+ +### Prepare for claiming your WG3000 Gateway + + + + + #### Find the barcode on the WG3000 Gateway + + You can find the barcode on the back of the WG3000 Gateway. You will need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + +:::tip +In case you have trouble scanning the barcode, you can manually type the serial number and claiming key. +::: + +
+### Enter your Claiming key + + + + + #### Navigate to W3000 Gateway and reveal the claiming key + + Navigate to "Device Settings" menu by pressing the arrow keys on your WG3000 Gateway right on the screen and select the "Claim Device" option, a QR code will appear. + + You'll need to scan the QR code in the WeatherXM app in order to verify that you own this station and secure it for yourself. + + + + +:::tip +The claiming key is a 6 digits code that is used to claim your station. The device remains on claiming mode for 10 minutes. If you don't claim it in this time frame, you will need to repeat the process. +::: + +
+ +### Confirm station installation Location & Claim your Device + + + + +#### Select the Location that you'll Install your Station + +Allow access to your location so that the WeatherXM app knows where you are planning to install your weather station. Doing so will make it easier to complete this step. + +Alternatively, you can find the location manually using the map. + +Once you've found the right location, tap on the checkbox to confirm and then tap on "Claim" button. + +All you need to do now, is to add your compatible wallet so you can receive WXM rewards. To do so, please follow the instructions in the chapter ["Add/edit wallet address"](/mobile-app/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). + +That's it! You've now claimed your new weather station and you'll be able to see its data on your WeatherXM app! + +:::note +We do not track you, nor do we collect any data about your location. +::: + +:::caution +Make sure you define the location that you will install your station as precisely as possible, as this is important for the quality of data you will share with the network and thus your overall WXM rewards. +::: + +:::caution +Your first rewards will appear after 24 hours of the station being online. +::: + + +:::info +Usually, it takes up to 30 minutes for the station to appear on the [explorer](https://explorer.weatherxm.com/stats) +::: diff --git a/static/llms-pages/wxm-devices/pulse/contents.md b/static/llms-pages/wxm-devices/pulse/contents.md new file mode 100644 index 00000000..e6906607 --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/contents.md @@ -0,0 +1,88 @@ +# Box Contents of Pulse bundle (WB3000) + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/contents + +## Included + + +

Included in the Box

+
    +
  1. Wind speed sensor
    2. +
  2. Weather station
    3. +
  3. Wind vane
    4. +
  4. Bracket (for WG3000 Gateway)
    5. +
  5. Bracket (for pole mounting)
    6. +
  6. Jubilee clips (x2)
    7. +
  7. Screws for securing the bracket to WG3000 Gateway (x3)
    8. +
  8. Screws and fischer wall plugs (x2)
    9. +
  9. WG3000 Gateway
    10. +
  10. Power supply cable (USB-C)
    11. +
  11. External Battery Pack
    12. +
  12. Zip ties
    13. +
  13. Bird Spikes
    14. +
+ + +## Not Included + +You would also need: +1. Batteries 1.5V **not rechargeable** (x2 AA) +1. Metal mounting pole (recommended 50mm/2in pole diameter & at least 2m/6.56ft height) +1. Tools and parts to secure the pole + +:::danger +If you use rechargeable batteries, you may harm your device +::: + +
+ +## Main Parts + +### Outdoor Weather Station + +The outdoor sensor is a set of sensors encased in a plastic shell that ensures the proper function of the weather station. + +The outdoor sensor is responsible for: + +1. the collection of measurements of local temperature, humidity, rain, wind speed and wind direction, and +1. the wireless transmission of the data to the weather miner. + + + +

Components

+
    +
  1. Wind Speed Sensor
    2. +
  2. Wind Vane
    3. +
  3. Thermo-hygro sensor
    4. +
  4. Rain collector
    5. +
  5. Bubble level
    6. +
  6. Solar panel
    7. +
  7. Antenna
    8. +
  8. Light sensor
    9. +
  9. U-Bolts
    10. +
  10. Battery compartment
    11. +
  11. Reset button
    12. +
  12. LED Indicator: light on for 4s on powers up. Then the LED will flash once every 20 seconds (the sensor transmission update period).
    13. +
+ + +This part of your weather station is placed outdoors. +For further details about an advisable installation of the outdoor sensor, please see [Installing the WS1001 Weather Station](/wxm-devices/pulse/install-weather-station). + +The above figures show a sketch of the outdoor sensor. The sketch comes with a description of all the important parts and sensors of it. + +### WG3000 Gateway + + + +The WG3000 Gateway is the device responsible for receiving weather measurements from the outdoor sensor and transmitting them via cellular connection to the WeatherXM network. + +The WG3000 Gateway is advised to be placed outdoors, ideally on a the same pole as the Weather Station, to ensure the best possible connection to the cellular network and with the Weather Station. + +
+ +## Help & Support + +You can find our team in our Discord Community Server. + +Alternatively, you can always contact us through [support](https://support.weatherxm.com) for any questions or issues you may have. diff --git a/static/llms-pages/wxm-devices/pulse/install-weather-station.md b/static/llms-pages/wxm-devices/pulse/install-weather-station.md new file mode 100644 index 00000000..fd6b66e8 --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/install-weather-station.md @@ -0,0 +1,29 @@ +# Installing WS1001 Weather station + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/install-weather-station + +## Prerequisites for proper installation +1. Pole of at least 2m/6.5ft (not included) +1. Base or bolts to secure in place (not included) +1. Location and spacing (Best Practices for Proper Station Installation) + +:::caution +It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards. +::: + + + +
+ +## Mounting the outdoor sensor + + + If this is the first time that you set up this outdoor sensor, + then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.
+ When you are about to fasten the pole on which you have tightened the outdoor sensor, look at the bubble level. + After fastening the pole, the bubble should be fully inside the red circle.
+ If it is not, wind direction, speed, and rain readings may not operate correctly or accurately.
+ Adjust the mounting pole as necessary. If the bubble is close, but not quite inside the circle + and you cannot adjust the mounting pole, you may try small wooden or heavy cardboard shims between the outdoor sensor + and the top of the mounting pole to achieve the desired result (this will require loosening the bolts and some experimentation).
+ Now, you may tighten the bolts with a wrench. diff --git a/static/llms-pages/wxm-devices/pulse/introduction.md b/static/llms-pages/wxm-devices/pulse/introduction.md new file mode 100644 index 00000000..e4a3d54f --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/introduction.md @@ -0,0 +1,160 @@ +# Introduction of Pulse bundle (WB3000) + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/introduction + +

You're now the proud owner of a WeatherXM Station. Welcome to the People's Weather Network!

+ + + +
+ +## Next steps + +You just got your station, or, you will soon! +Let's see what are the necessary steps in order to properly assemble, install, claim and enable it to send data in order to receive $WXM reward tokens. + +### Check the box contents + +Make sure that everything is in order and you're all set to proceed with station assembly. + +View Contents + +### Assemble your weather station + +Assemble all parts and make sure all sensors work as expected. For this step, **you will need 2 AA batteries that are not included in the box.** + +View Station Assembly Instructions + +### Install your weather station + +This is one of the most important steps, as proper installation is key in order to collect valid weather data. For this step, **you will need a pole that is at least 2m/6.5ft and a way to secure it in place (both not included in the box).** Here you will also see the best practices on how to properly install the station according to WMO. + +View Station Installation Instructions + +### Connect and claim station + +Once you've finished with installation, you can connect your station to your WG3000 Gateway and claim them as your own in WeatherXM network. To do this, **you will need to download our WeatherXM app (Android and iOS).** + +View Connect and Claim Instructions + +### Add your ERC20 compatible wallet + +In order to receive WXM rewards, you will need to connect an ERC20 compatible wallet which supports Arbitrum One Network. We have prepared a guide to do so using MetaMask (although it is not mandatory to use this). + +View Wallet Addition Instructions + +## Features and Specifications + +### WG3000 Gateway + +- Cellular (2G/3G/LTE) + GPS + LoRa +- Hardware encryption +- Forwards weather data via Cellular networks (Integrated SIM card) +- Powered by integrated battery and solar panel (ext. power supplies supported) +- Over-the-air firmware upgradable +- Reporting Interval: 20min + +### WS1001 Weather Station + + + + + +Powered via a small solar panel and batteries and communicates with the WG3000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG3000 Gateway is 100m with line of sight. +- #### Temperature: + + - Range: -40 ~ +60°C + - Accuracy: 0.2°C + - Resolution: 0.1°C + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 300 mm/h + - Accuracy: ±10% + - Resolution: 0.3mm + +- #### Wind Speed: + + - Range: 0 ~ 50m/s + - Accuracy: ±1m/s (wind speed < 5m/s), ±10% (wind speed > 5m/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + +Powered via a small solar panel and batteries and communicates with the WG3000 Gateway via RF (Radio Frequencies). +The maximum distance between this station and the WG3000 Gateway is 328ft with line of sight. +- #### Temperature: + + - Range: -40 ~ +140 °F + - Accuracy: 0.2 °F + - Resolution: 0.1 °F + +- #### Relative Humidity: + + - Range: 10% ~ 99% + - Accuracy: ±5% + +- #### Rain Volume: + + - Range: 0 ~ 11.8 in/h + - Accuracy: ±10% + - Resolution: 0.01 in + +- #### Wind Speed: + + - Range: 0 ~ 3.2 ft/s + - Accuracy: ±3.2 ft/s (wind speed < 16.4 ft/s), ±10% (wind speed > 16.4 ft/s) + +- #### Wind Direction: + + - Range: 0 ~ 359 degrees + +- #### Illuminance: + + - Range: 0 ~ 200 klux + - Accuracy: ±25% + +- #### Pressure: + + - Range: 300 ~ 1100 hPa (equivalent to +9000m ~ -500m above / below sea level) + - Accuracy: ±3.9Pa + - Resolution: 0.06Pa + +- #### Sensor : + - GPS sensor Integrated + - Reporting Interval: 20sec + + + + diff --git a/static/llms-pages/wxm-devices/pulse/maintenance.md b/static/llms-pages/wxm-devices/pulse/maintenance.md new file mode 100644 index 00000000..2d811c1a --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/maintenance.md @@ -0,0 +1,41 @@ +# Maintenance of Pulse bundle (WB3000) + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/maintenance + +## WS1001 Weather Station + +The maintenance of the weather station is an important process, which should be conducted meticulously over the suggested period of time. +This process includes the cleaning of certain parts of the outdoor unit and the replacement of batteries. + +In order to avoid faulty measurements, you may turn off the WG3000 Gateway until finishing the entire process. + +The maintenance process is summarised in the following steps. + +### Rain Gauge +Clean the rain gauge at least once every 3 months. +Rotate the funnel counter-clockwise and lift to expose the rain gauge mechanism +and clean with a damp cloth. Remove any dirt, debris and insects. +If bug infestation is an issue, spray the array lightly with insecticide. +It is important not to swing the rain gauge spoon during this process, +as the weather station will measure and record faulty precipitation. +The sketch below shows how to open the rain gauge. + + + +### Solar Panel +Clean the solar panel at least every 3 months with a damp cloth. + +### Thermo-Hygro Sensor +Remove any dirt, debris and insects from the [thermo-hygro sensor](/wxm-devices/d1/contents#outdoor-weather-station) every 12 months. It may be needed to open the radiation shield using a screwdriver and fully clean the thermo-hygro sensor in case there is too much debris on it. + +
+:::note +You should occasionally check the battery level of the weather station via the settings menu on the mobile app. If the battery level is low, you should replace the batteries. +In harsh environments, inspect the batteries every 3 months (e.g. when cleaning the solar panel). +::: + +
+ +## WG3000 Gateway + +WG3000 Gateway only requires minimal maintenance, which includes the cleaning of the solar panel and the visual inspection of the device. diff --git a/static/llms-pages/wxm-devices/pulse/troubleshooting.md b/static/llms-pages/wxm-devices/pulse/troubleshooting.md new file mode 100644 index 00000000..c2474cfb --- /dev/null +++ b/static/llms-pages/wxm-devices/pulse/troubleshooting.md @@ -0,0 +1,103 @@ +# Troubleshooting of Pulse Bundle (WB3000) + +Canonical: https://docs.weatherxm.com/wxm-devices/pulse/troubleshooting + +## Weather Station + +### Data Gaps + +If the error message "Data gaps" is displayed on the mobile app, the WG300 Gateway is not receiving RF signals. +This can be due to a variety of reasons. + +First make sure you WG3000 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/pulse/connect-and-claim#change-frequency-optional)) + +Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/pulse/assemble)) for flashing. +The LED should flash every 20 seconds. + +If the LED is not flashing every 20 seconds, replace the batteries in the weather station. +If the batteries were recently replaced, check the polarity. + +If the above does not solve the issue, there may be a temporary loss of communication due to reception loss related to interference or other location factors. +Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +1. With the weather station array and WG3000 Gateway 3m/10ft away from each other, + remove the batteries from the weather station and wait 10 seconds. Put the batteries back in. + +2. Try to place the WG3000 Gateway at the desirable point and check that it receives data. + +3. If you still have intermittent problems, move the weather station and the WG3000 Gateway closer together, + but not closer than 1.5m/5ft or further than 50m/164ft. + Also check that there are no metal barriers like aluminum siding + or metal wall framing along the line of sight between the weather station and WG3000 Gateway. + Relocate the weather station and WG3000 Gateway as necessary to avoid obstacles. + Depending on natural barriers you may also have to move the weather station higher and/or closer. + +:::note +It is recommended to place the WG3000 Gateway on the same pole as the weather station. +::: + +
+ +### Station Battery Level is Low + +If your Mobile App reports "Station Battery Level is Low" on the screen, the weather station will run out of battery soon. + +Replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Temperature looks higher than expected. + +If the temperature is slightly higher (e.g., +2 - 5°C/35-41°F) than expected, +then assure that the weather station is within a significant distance from heat sources +like ventilation systems and active chimneys. +Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metallic pole and there are no obstacles close by reading [Best Practices for Proper Station Installation](/wxm-devices/pulse/install-weather-station#best-practices-for-proper-station-installation). + +
+ +### Other variables, such as wind direction, wind speed, rain height and humidity do not align with an official weather reporting station + +Even weather stations, which are close to each other, may obtain slightly different measurements, +especially for the variables of wind speed and wind direction. However, you should not expect significant deviations +e.g., from a weather station, which is located within a distance of 1km/0.6mi. +If there are deviations, please check [Best Practices for Proper Station Installation](/wxm-devices/pulse/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. + +
+ +### One or more variables are extremely high, low, or constant for long periods of time. + +If you notice that some variables are extreme or constant it is possible you need to replace the batteries of the weather station. Make sure you use lithium non-rechargeable batteries, especially in case of cold weather environments. + +
+ +### Reported pressure appears to be very low relatively to other reference stations of national or private networks etc. + +For now we present only the absolute pressure and not the Mean Sea Level Pressure (MSLP). That means that the displayed pressure are affected by the elevation of your area. We work to consider the elevation given by your GPS in order to show the MSLP, which is commonly used. + +
+ +## GPS Location + +### Location not verified +You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/rewards/proof-of-location) flags your weather station because the location reported by its **GPS receiver(s)** is different than the location you declared during the setup and claiming of the station. This happens because either you moved the station from its initial installation site, or you declared a wrong location during the onboarding of the station on your mobile app. + +This incurs a "relocation penalty" (as mentioned in [the whitepaper](http://weatherxm.com/whitepaper)) meaning your station will be exempt from reward distribution until the weather station is moved back to the declared location or the location is updated by using the "relocate station" function on your mobile app. After the passing of **7 days** from fixing your location, the relocation penalty will be lifted and your station will start generating rewards as usual. + +## Other Issues + +### My WG3000 Gateway is stuck/unresponsive. + +Please do not restart it and contact us through [support](https://support.weatherxm.com) to debug it and find the reason of the issue. + +
+ +### Why is my station showing offline? + +Assuming that the WG3000 Gateway unit is placed outdoors facing south, this may be due to a bad RF connection between that Gateway and the outdoor station. +Please make sure that the WG3000 Gateway is placed outdoors, ideally on the same pole as the Weather Station, to ensure the best possible connection to the cellular network and with the Weather Station. + +
+ +:::note +if you are still experiencing issues, please contact us through [support](https://support.weatherxm.com) +::: diff --git a/static/llms.txt b/static/llms.txt new file mode 100644 index 00000000..c1883ddc --- /dev/null +++ b/static/llms.txt @@ -0,0 +1,42 @@ +# WeatherXM Documentation + +> Technical documentation for WeatherXM weather stations, deployment, data quality, rewards, WeatherXM Pro and weather science. + +## Canonical resources +- Main WeatherXM site: https://weatherxm.com/ +- Weather station catalog: https://weatherxm.com/stations/ +- Data & forecasts: https://weatherxm.com/data/ +- Open technology: https://weatherxm.com/open/ +- Firmware flasher: https://flasher.weatherxm.com/ +- Network Association: https://weatherxm.network/ +- GitHub: https://github.com/WeatherXM + +## Key documentation +- Homepage: https://docs.weatherxm.com/ + - Markdown: https://docs.weatherxm.com/llms-pages/index.md +- Help Center / FAQ: https://docs.weatherxm.com/faq + - Markdown: https://docs.weatherxm.com/llms-pages/faq.md +- Glossary of Common Terms: https://docs.weatherxm.com/glossary + - Markdown: https://docs.weatherxm.com/llms-pages/glossary.md +- Introduction: https://docs.weatherxm.com/introduction + - Markdown: https://docs.weatherxm.com/llms-pages/introduction.md +- Weather And Science: https://docs.weatherxm.com/weather-and-science + - Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science.md +- General QoD Description (OBC-SQC, ISD, SPV): https://docs.weatherxm.com/weather-and-science/quality-mechanisms/general-qod-description + - Markdown: https://docs.weatherxm.com/llms-pages/weather-and-science/quality-mechanisms/general-qod-description.md +- WeatherXM Pro: https://docs.weatherxm.com/weatherxm-pro + - Markdown: https://docs.weatherxm.com/llms-pages/weatherxm-pro.md +- Introduction of D1 bundle (WB1200): https://docs.weatherxm.com/wxm-devices/d1/introduction + - Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/d1/introduction.md +- Weather Station Deployment Examples: https://docs.weatherxm.com/wxm-devices/deployment-examples + - Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/deployment-examples.md +- Introduction WeatherXM Helium station (WS2000): https://docs.weatherxm.com/wxm-devices/helium/introduction + - Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/helium/introduction.md +- Introduction of Pulse bundle (WB3000): https://docs.weatherxm.com/wxm-devices/pulse/introduction + - Markdown: https://docs.weatherxm.com/llms-pages/wxm-devices/pulse/introduction.md + +## Full corpus +- Combined text corpus: https://docs.weatherxm.com/llms-full.txt +- Individual Markdown mirrors are under https://docs.weatherxm.com/llms-pages/ + +Use the canonical HTML URL when citing a page. Use the Markdown mirror when a text-only representation is easier to process. diff --git a/static/robots.txt b/static/robots.txt new file mode 100644 index 00000000..8d198551 --- /dev/null +++ b/static/robots.txt @@ -0,0 +1,7 @@ +User-agent: * +Allow: / + +User-agent: OAI-SearchBot +Allow: / + +Sitemap: https://docs.weatherxm.com/sitemap.xml