diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 2f3cf802..ea7f2144 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -15,12 +15,10 @@ jobs: with: node-version: 20.x cache: yarn - - name: Install dependencies run: yarn install --immutable - name: Build website run: yarn build - - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: diff --git a/.github/workflows/dev-docs-deployment.yaml b/.github/workflows/dev-docs-deployment.yaml deleted file mode 100644 index 94e1d600..00000000 --- a/.github/workflows/dev-docs-deployment.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: Deploy on Dev Server - -on: - workflow_dispatch: - push: - tags: - - "staging" - -jobs: - build: - runs-on: self-hosted - steps: - - uses: actions/checkout@v3 - - name: Run a multi-line script - run: | - echo Updating docs container... - docker-compose down --remove-orphans - docker-compose up -d --build --force-recreate diff --git a/.github/workflows/test-deploy.yaml b/.github/workflows/test-deploy.yaml index 29f06e9e..9701af44 100644 --- a/.github/workflows/test-deploy.yaml +++ b/.github/workflows/test-deploy.yaml @@ -15,7 +15,6 @@ jobs: with: node-version: 20.x cache: yarn - - name: Install dependencies run: yarn install --immutable - name: Test build website diff --git a/docs/help-center/faq.mdx b/docs/faq.mdx similarity index 95% rename from docs/help-center/faq.mdx rename to docs/faq.mdx index 0c820de3..3a64ad20 100644 --- a/docs/help-center/faq.mdx +++ b/docs/faq.mdx @@ -1,9 +1,6 @@ --- -id: faqs title: Help Center / FAQ -hide_title: false sidebar_label: Help Center / FAQ -slug: /faqs --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -24,7 +21,7 @@ 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](/project/proof-of-location). +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 @@ -52,7 +49,7 @@ You can connect your WeatherXM Helium compatible station anywhere with Helium ne ### 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](/deployment-examples) for inspiration. +You can also check the [deployment examples](/wxm-devices/deployment-examples) for inspiration.
@@ -70,13 +67,13 @@ We approximately follow the [frequency assignments of TTN per country](https://w ### 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](/wallet/add-edit-wallet-address) and then follow this guide to [claim your rewards](/project/rewards-claiming). +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](/project/rewards-claiming). +You can check your rewards by using our mobile App and follow this guide to [claim your rewards](/rewards/rewards-claiming).
diff --git a/docs/glossary/glossary.mdx b/docs/glossary.mdx similarity index 99% rename from docs/glossary/glossary.mdx rename to docs/glossary.mdx index 775b019d..730c44f4 100644 --- a/docs/glossary/glossary.mdx +++ b/docs/glossary.mdx @@ -1,8 +1,6 @@ --- -id: glossary title: Glossary of Common Terms sidebar_label: Glossary of Common Terms -slug: /glossary --- | Term | Description | diff --git a/docs/home.mdx b/docs/home.mdx index 39a27586..fef6ae06 100644 --- a/docs/home.mdx +++ b/docs/home.mdx @@ -1,10 +1,8 @@ --- -id: home title: Homepage hide_title: true sidebar_label: Home slug: / -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -17,7 +15,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
- +

WeatherXM M5 bundle (WB1000)

@@ -26,7 +24,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
- +

WeatherXM Helium station (WS2000)

@@ -38,7 +36,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
- +

WeatherXM D1 bundle (WB1200)

@@ -47,7 +45,7 @@ WeatherXM weather stations are the world’s first to natively support Web3 tech
- +

WeatherXM Pulse bundle (WB3000)

@@ -71,11 +69,11 @@ This documentation site attempts to explain various aspects of the WeatherXM pro • The $WXM Token

-• Reward Mechanism +• Reward Mechanism

-• Quality of Data (QoD) +• Quality of Data (QoD)

-• Proof of Location (PoL) +• Proof of Location (PoL)



Join our Discord Community Server. diff --git a/docs/introduction.mdx b/docs/introduction.mdx index eaed4560..a1c01457 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -1,9 +1,7 @@ --- -id: introduction title: Introduction hide_title: true sidebar_label: Introduction -slug: /introduction hide_table_of_contents: true --- @@ -33,26 +31,26 @@ You can stay updated on the current state of the network by checking out our [ex Some significant milestones we have achieved so far: ### Reward Mechanism -Current [Reward Mechanism v2.0](/reward-mechanism) includes significant improvements over previous versions. +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](/reward-mechanism). +More on [Reward Mechanism](/rewards/reward-mechanism). ### Quality of Data (QoD) -[Quality of Data (QoD)](/project/quality-of-data) 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 QoD 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 QoD score. +[Quality of Data (QoD)](/rewards/quality-of-data) 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 QoD 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 QoD score. To achieve this, QoD relies on a range of techniques and processes designed to help us differentiate between expected and unexpected data behaviors. -More on [Quality of Data](/project/quality-of-data). +More on [Quality of Data](/rewards/quality-of-data). ### WeatherXM Devices Currently we use 4 main types of devices: -- [WeatherXM M5 Bundle (WB1000)](/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction) which is the WiFi version -- [WeatherXM Helium Version (WS2000) ](/wxm-devices/helium-bundle/wxm-ws2000-introduction) which is the Helium version -- [WeatherXM D1 bundle (WB1200)](/wxm-devices/D1-bundle/D1-bundle-introduction) which is the upgraded WiFi version -- [WeatherXM Pulse bundle (WB3000)](/wxm-devices/pulse-bundle/introduction) which is the 4G/LTE version +- [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/docs/account/change-password.mdx b/docs/mobile-app/change-password.mdx similarity index 95% rename from docs/account/change-password.mdx rename to docs/mobile-app/change-password.mdx index 2e7c6505..1fb1eeb3 100644 --- a/docs/account/change-password.mdx +++ b/docs/mobile-app/change-password.mdx @@ -1,9 +1,6 @@ --- -id: change-password title: How to change password to your account -hide_title: false sidebar_label: Change Password -slug: /account/change-password --- import Tabs from "@theme/Tabs"; diff --git a/docs/account/delete-account.mdx b/docs/mobile-app/delete-account.mdx similarity index 94% rename from docs/account/delete-account.mdx rename to docs/mobile-app/delete-account.mdx index 91369081..2c9a08c6 100644 --- a/docs/account/delete-account.mdx +++ b/docs/mobile-app/delete-account.mdx @@ -1,9 +1,6 @@ --- -id: delete-account title: Delete WXM Account -hide_title: false sidebar_label: Delete WXM Account -slug: /account/delete-account --- import Tabs from "@theme/Tabs"; diff --git a/docs/wallet/add-edit-wallet-address.mdx b/docs/mobile-app/wallet/add-edit-wallet-address.mdx similarity index 95% rename from docs/wallet/add-edit-wallet-address.mdx rename to docs/mobile-app/wallet/add-edit-wallet-address.mdx index b7939fb1..b04b96fb 100644 --- a/docs/wallet/add-edit-wallet-address.mdx +++ b/docs/mobile-app/wallet/add-edit-wallet-address.mdx @@ -1,9 +1,6 @@ --- -id: add-edit-wallet-address title: Add/edit wallet address -hide_title: false sidebar_label: Add/edit wallet address -slug: /wallet/add-edit-wallet-address --- import Tabs from "@theme/Tabs"; @@ -11,7 +8,7 @@ import ThemedImage from '@theme/ThemedImage'; import useBaseUrl from "@docusaurus/useBaseUrl"; :::tip -If you don’t have a wallet, [create one](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +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. ::: diff --git a/docs/rewards/cell-capacity.mdx b/docs/rewards/cell-capacity.mdx index 41b807c1..887964de 100644 --- a/docs/rewards/cell-capacity.mdx +++ b/docs/rewards/cell-capacity.mdx @@ -1,15 +1,13 @@ --- -id: cell-capacity title: Cell Capacity (CC) sidebar_label: Cell Capacity (CC) -slug: /project/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) ](/reward-mechanism) section, and then by seniority) will receive rewards. +(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*. diff --git a/docs/rewards/hardware-class.mdx b/docs/rewards/hardware-class.mdx index 8e6b6e43..8b008028 100644 --- a/docs/rewards/hardware-class.mdx +++ b/docs/rewards/hardware-class.mdx @@ -1,8 +1,6 @@ --- -id: hardware-class title: Hardware Class sidebar_label: Hardware Class -slug: /project/hardware-class --- Hardware-Class Weight (HCW): HCW is a rational number > 0. diff --git a/docs/rewards/how-to-join-arbitrum-and-see-your-tokens.mdx b/docs/rewards/how-to-join-arbitrum-and-see-your-tokens.mdx index c8f82e74..1860592b 100644 --- a/docs/rewards/how-to-join-arbitrum-and-see-your-tokens.mdx +++ b/docs/rewards/how-to-join-arbitrum-and-see-your-tokens.mdx @@ -1,8 +1,6 @@ --- -id: how-to-join-arbitrum-and-see-your-tokens title: How to join Arbitrum and see your tokens sidebar_label: How to join Arbitrum and see your tokens -slug: /rewards/how-to-join-arbitrum-and-see-your-tokens --- import Tabs from "@theme/Tabs"; @@ -10,7 +8,7 @@ import TabItem from "@theme/TabItem"; import useBaseUrl from "@docusaurus/useBaseUrl"; :::tip -If you don’t have a wallet, [create one](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask) which is recommended if you want to see test tokens. +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 diff --git a/docs/rewards/proof-of-location.mdx b/docs/rewards/proof-of-location.mdx index fa41d7c2..3927ee46 100644 --- a/docs/rewards/proof-of-location.mdx +++ b/docs/rewards/proof-of-location.mdx @@ -1,8 +1,6 @@ --- -id: proof-of-location title: Proof of Location (PoL) sidebar_label: Proof of Location (PoL) -slug: /project/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. diff --git a/docs/rewards/quality-of-data.mdx b/docs/rewards/quality-of-data.mdx index 229bf7c8..ee416cff 100644 --- a/docs/rewards/quality-of-data.mdx +++ b/docs/rewards/quality-of-data.mdx @@ -1,8 +1,6 @@ --- -id: quality-of-data title: Quality of Data (QoD) sidebar_label: Quality of Data (QoD) -slug: /project/quality-of-data --- :::info diff --git a/docs/rewards/reward-boosts.mdx b/docs/rewards/reward-boosts.mdx index ba2852c3..91095a9e 100644 --- a/docs/rewards/reward-boosts.mdx +++ b/docs/rewards/reward-boosts.mdx @@ -1,8 +1,6 @@ --- -id: reward-boosts title: Reward Boosts sidebar_label: Reward Boosts -slug: /project/reward-boosts --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -10,7 +8,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ## Overview -**Reward boosts** are additional rewards given to stations that contribute weather data during daily distribution, in addition to the [**base rewards**](/reward-mechanism#daily-rewards-calculation-process). Learn more about the daily rewards in the [Reward Mechanism (RM) ](/reward-mechanism) section. +**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. @@ -57,7 +55,7 @@ The project's Beta period officially ended on May 27th (UTC). All station-hours 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](/wallet/add-edit-wallet-address). +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 @@ -70,7 +68,7 @@ Cell Boost is a mechanism that can be used to incentivise weather stations deplo ## Examples of reward programs that may be implemented using **Rewards Boost**, in the near future are: -- Backfill of rewards that were not allocated to certain devices due to malfunctions in the [Quality of Data (QoD) mechanism](/project/quality-of-data) or [Proof of Location (PoL) mechanism](/project/proof-of-location). +- Backfill of rewards that were not allocated to certain devices due to malfunctions in the [Quality of Data (QoD) mechanism](/rewards/quality-of-data) or [Proof of Location (PoL) mechanism](/rewards/proof-of-location). - 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. diff --git a/docs/rewards/reward-mechanism.mdx b/docs/rewards/reward-mechanism.mdx index 40169934..a466b760 100644 --- a/docs/rewards/reward-mechanism.mdx +++ b/docs/rewards/reward-mechanism.mdx @@ -1,8 +1,6 @@ --- -id: reward-mechanism title: Reward Mechanism sidebar_label: Reward Mechanism -slug: /reward-mechanism --- ## Introduction @@ -201,17 +199,17 @@ 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](/project/proof-of-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). * **Quality-of-Data (QoD)**: 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 QoD 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 QoD score possible. Read more about the [Quality of Data (QoD) mechanism](/project/quality-of-data). + guidelines in order to consistently achieve the best QoD score possible. Read more about the [Quality of Data (QoD) mechanism](/rewards/quality-of-data). * **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](project/hardware-class). +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)](project/cell-capacity). +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. @@ -298,7 +296,7 @@ Due to blockchain limitations on the number of atomic transfer transactions that ## Links - [WeatherXM Network](https://weatherxm.network/) -- [Quality of Data (QoD) mechanism](/project/quality-of-data) -- [Proof of Location (PoL) mechanism](/project/proof-of-location) -- [Cell Capacity (CC)](project/cell-capacity) -- [Hardware class](project/hardware-class) \ No newline at end of file +- [Quality of Data (QoD) mechanism](/rewards/quality-of-data) +- [Proof of Location (PoL) mechanism](/rewards/proof-of-location) +- [Cell Capacity (CC)](/rewards/cell-capacity) +- [Hardware class](/rewards/hardware-class) \ No newline at end of file diff --git a/docs/rewards/rewards-claiming.mdx b/docs/rewards/rewards-claiming.mdx index cc7ab463..4de2f195 100644 --- a/docs/rewards/rewards-claiming.mdx +++ b/docs/rewards/rewards-claiming.mdx @@ -1,8 +1,6 @@ --- -id: rewards-claiming title: How to Claim Rewards sidebar_label: Rewards Claiming -slug: /project/rewards-claiming --- import Tabs from "@theme/Tabs"; diff --git a/docs/rewards/rewards-troubleshooting.mdx b/docs/rewards/rewards-troubleshooting.mdx index 0d44123e..448a5c9a 100644 --- a/docs/rewards/rewards-troubleshooting.mdx +++ b/docs/rewards/rewards-troubleshooting.mdx @@ -1,8 +1,6 @@ --- -id: rewards-troubleshooting title: Rewards Troubleshooting sidebar_label: Troubleshooting -slug: /project/rewards-troubleshooting --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -13,10 +11,10 @@ A guide to interpreting mobile app error messages, understanding their meanings, 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](/wallet/add-edit-wallet-address). +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) ](/reward-mechanism) completes. This usually takes until the following day and see "[How to Claim Rewards](/project/rewards-claiming)" for further guidance. +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.
@@ -42,28 +40,28 @@ Here's what you need to do:
-- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wifi-m5-bundle/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](/wifi-m5-bundle/m5-troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- 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](/wifi-m5-bundle/m5-troubleshooting#no-location-gps-data-arrow-icon-is-red). -- Follow the Troubleshooting guide regarding [No WiFi connection](/wifi-m5-bundle/m5-troubleshooting#no-wifi--connection). +- 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 WS-2000 (Helium version) 1. Check if the station's battery level is low through mobile app settings. -2. Check for [Helium coverage](https://docs.weatherxm.com/helium-bundle/helium-troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. +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 [Quality of Data (QoD) algorithm](/project/quality-of-data). For more information about this algorithm, please refer to this [here](/project/quality-of-data). +To ensure the accuracy of the information sent by our weather stations, we evaluate all data packets using our [Quality of Data (QoD) algorithm](/rewards/quality-of-data). For more information about this algorithm, please refer to this [here](/rewards/quality-of-data). Below are some of the possible errors and the appropriate actions you can take to resolve the issues: @@ -81,13 +79,13 @@ If the above doesn't work, you should contact our [support team](https://support #### 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](/deployment-examples) and [Best Practices](/wxm-devices/wifi-m5-bundle/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. +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](/deployment-examples) and [Best Practices](/wxm-devices/wifi-m5-bundle/install-weather-station#best-practices-for-proper-station-installation) to ensure that your station is deployed correctly. +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. @@ -131,21 +129,21 @@ Here's what you need to do:
-- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wifi-m5-bundle/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](/wifi-m5-bundle/m5-troubleshooting#my-station-does-not-connect-to-the-wg1000-gateway). +- 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](/wifi-m5-bundle/m5-troubleshooting#no-location-gps-data-arrow-icon-is-red). -- Follow the Troubleshooting guide regarding [No WiFi connection](/wifi-m5-bundle/m5-troubleshooting#no-wifi--connection). +- 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 WS-2000 (Helium version) 1. Check if the station's battery level is low through mobile app settings. -2. Check for [Helium coverage](https://docs.weatherxm.com/helium-bundle/helium-troubleshooting#how-to-see-if-there-is-helium-coverage-in-your-area) in your area. +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 @@ -163,17 +161,17 @@ If the battery is low, the connection between your station and the WG1000 gatewa
-- Check that your station connection (RF) to the gateway is stable by following the guide [here](/wxm-devices/D1-bundle/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-bundle/D1-troubleshooting#one-or-more-variables-are-extremely-high-low-or-constant-for-long-periods-of-time). +- 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-bundle/D1-troubleshooting#device-alert-no-internet-connection). +- 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 [Quality of Data (QoD) algorithm](/project/quality-of-data) 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](/deployment-examples) and [Best Practices](/wxm-devices/wifi-m5-bundle/install-weather-station#best-practices-for-proper-station-installation) for inspiration on how and where to install your station. +It appears that your weather station could benefit from some improvements in terms of its deployment. The [Quality of Data (QoD) algorithm](/rewards/quality-of-data) 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.
@@ -183,13 +181,13 @@ Your weather station was suspended from rewards because it did not report GPS da ### For the WG1000 - WiFi gateway -1. [No location (GPS) data (arrow icon is red)](/wifi-m5-bundle/m5-troubleshooting#no-location-gps-data-arrow-icon-is-red) -2. [Place the WG1000 near a window (for better GPS signal)](/wxm-devices/wifi-m5-bundle/m5-connect-and-claim#place-wg1000-gateway-near-a-window-for-better-gps-signal) +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 WS-2000 (Helium version) -1. [No location (GPS) data](/helium-bundle/helium-troubleshooting#no-location-gps-data) -2. [Installation instructions](/wxm-devices/helium-bundle/helium-install-weather-station) +1. [No location (GPS) data](/wxm-devices/helium/troubleshooting#no-location-gps-data) +2. [Installation instructions](/wxm-devices/helium/install-weather-station)
@@ -203,7 +201,7 @@ Please verify your location through the mobile app. -In detail, the [Proof of Location (PoL) mechanism](/project/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. +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. @@ -215,18 +213,18 @@ It is crucial for the stability of the Network to have weather stations that can ::: :::note -[Proof of Location (PoL) mechanism](/project/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. +[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](/project/proof-of-location) reported a relocation event. +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](/project/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 [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. ::: \ No newline at end of file diff --git a/docs/the-$WXM-token.mdx b/docs/the-$WXM-token.mdx index 8fe2fb97..a8832fb4 100644 --- a/docs/the-$WXM-token.mdx +++ b/docs/the-$WXM-token.mdx @@ -1,10 +1,8 @@ --- id: tokenomics title: The $WXM Token -hide_title: false sidebar_label: The $WXM Token slug: /tokenomics -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; diff --git a/docs/wxm-devices/D1-bundle/D1-assemble.mdx b/docs/wxm-devices/d1/assemble.mdx similarity index 96% rename from docs/wxm-devices/D1-bundle/D1-assemble.mdx rename to docs/wxm-devices/d1/assemble.mdx index a81d1a42..8e196485 100644 --- a/docs/wxm-devices/D1-bundle/D1-assemble.mdx +++ b/docs/wxm-devices/d1/assemble.mdx @@ -1,8 +1,6 @@ --- -id: D1-assemble title: Assembling WS1001 Weather Station sidebar_label: Installation Instructions -slug: /wxm-devices/D1-bundle/D1-assemble --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -112,4 +110,4 @@ The U-bolts and the metal plate are used to support the mounting of the outdoor 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/wifi-m5-bundle/install-weather-station#mounting-the-outdoor-sensor)). +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/docs/wxm-devices/D1-bundle/D1-connect-and-claim.mdx b/docs/wxm-devices/d1/connect-and-claim.mdx similarity index 96% rename from docs/wxm-devices/D1-bundle/D1-connect-and-claim.mdx rename to docs/wxm-devices/d1/connect-and-claim.mdx index cb1cf5fc..641f4e3d 100644 --- a/docs/wxm-devices/D1-bundle/D1-connect-and-claim.mdx +++ b/docs/wxm-devices/d1/connect-and-claim.mdx @@ -1,8 +1,6 @@ --- -id: D1-connect-and-claim title: Connect and Claim the Gateway sidebar_label: Gateway Claiming -slug: /wxm-devices/D1-bundle/D1-connect-and-claim --- import Tabs from "@theme/Tabs"; @@ -26,7 +24,7 @@ In this chapter, you will find guidance to set up the WG1200 Gateway. 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-bundle/D1-connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +1. The [WeatherXM](/wxm-devices/d1/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone.
@@ -170,7 +168,7 @@ 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"](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). +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! diff --git a/docs/wxm-devices/D1-bundle/D1-contents.mdx b/docs/wxm-devices/d1/contents.mdx similarity index 96% rename from docs/wxm-devices/D1-bundle/D1-contents.mdx rename to docs/wxm-devices/d1/contents.mdx index 856a1b12..8a0e6df8 100644 --- a/docs/wxm-devices/D1-bundle/D1-contents.mdx +++ b/docs/wxm-devices/d1/contents.mdx @@ -1,8 +1,6 @@ --- -id: D1-contents title: Box Contents of D1 bundle (WB1200) sidebar_label: Box Contents -slug: /wxm-devices/D1-bundle/D1-contents --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -77,7 +75,7 @@ The outdoor sensor is responsible for: 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/wifi-m5-bundle/install-weather-station). +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. diff --git a/docs/wxm-devices/D1-bundle/install-weather-station.mdx b/docs/wxm-devices/d1/install-weather-station.mdx similarity index 94% rename from docs/wxm-devices/D1-bundle/install-weather-station.mdx rename to docs/wxm-devices/d1/install-weather-station.mdx index b61ebdc7..b9f1c972 100644 --- a/docs/wxm-devices/D1-bundle/install-weather-station.mdx +++ b/docs/wxm-devices/d1/install-weather-station.mdx @@ -1,8 +1,6 @@ --- -id: install-weather-station title: Installing WS1001 Weather station sidebar_label: Station Installation -slug: /wxm-devices/D1-bundle/install-weather-station --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -11,7 +9,7 @@ import Link from "@docusaurus/Link"; ## 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) +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. @@ -26,7 +24,7 @@ The values of the various meteorological parameters measured by a weather statio and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: :::info -Don't sure for your installation point? Check deployment examples [here](/deployment-examples). +Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). ::: ### Pole's Height diff --git a/docs/wxm-devices/D1-bundle/wb1200-introduction.mdx b/docs/wxm-devices/d1/introduction.mdx similarity index 87% rename from docs/wxm-devices/D1-bundle/wb1200-introduction.mdx rename to docs/wxm-devices/d1/introduction.mdx index bd03fa63..ade3cd95 100644 --- a/docs/wxm-devices/D1-bundle/wb1200-introduction.mdx +++ b/docs/wxm-devices/d1/introduction.mdx @@ -1,10 +1,6 @@ --- -id: D1-bundle-introduction title: Introduction of D1 bundle (WB1200) -hide_title: false sidebar_label: Introduction -slug: /wxm-devices/D1-bundle/D1-bundle-introduction -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -29,31 +25,31 @@ Let's see what are the necessary steps in order to properly assemble, install, c Make sure that everything is in order and you're all set to proceed with station assembly. -View Contents +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 +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 +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 +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 +View Wallet Addition Instructions ## Features and Specifications diff --git a/docs/wxm-devices/D1-bundle/maintenance.mdx b/docs/wxm-devices/d1/maintenance.mdx similarity index 84% rename from docs/wxm-devices/D1-bundle/maintenance.mdx rename to docs/wxm-devices/d1/maintenance.mdx index ed2b6d42..b8e46e6a 100644 --- a/docs/wxm-devices/D1-bundle/maintenance.mdx +++ b/docs/wxm-devices/d1/maintenance.mdx @@ -1,8 +1,6 @@ --- -id: maintenance title: Maintenance of WS1001 Weather Station sidebar_label: Maintenance -slug: /wxm-devices/D1-bundle/maintenance --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -30,7 +28,7 @@ The sketch below shows how to open the rain gauge. 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-bundle/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. +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 diff --git a/docs/wxm-devices/D1-bundle/D1-troubleshooting.mdx b/docs/wxm-devices/d1/troubleshooting.mdx similarity index 90% rename from docs/wxm-devices/D1-bundle/D1-troubleshooting.mdx rename to docs/wxm-devices/d1/troubleshooting.mdx index 76e65d53..50dc35ac 100644 --- a/docs/wxm-devices/D1-bundle/D1-troubleshooting.mdx +++ b/docs/wxm-devices/d1/troubleshooting.mdx @@ -1,8 +1,6 @@ --- -id: D1-troubleshooting title: Troubleshooting of D1 bundle (WB1200) sidebar_label: Troubleshooting -slug: /wxm-devices/D1-bundle/D1-troubleshooting --- import Tabs from "@theme/Tabs"; @@ -18,9 +16,9 @@ If the error message "No Weather Station Signal" is displayed on the WG1200 Gate 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-bundle/D1-connect-and-claim#change-frequency-optional)) +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-bundle/D1-contents#outdoor-weather-station)) for flashing. +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. @@ -46,7 +44,7 @@ The solution may be as simple as powering down and up the WG1200 Gateway. Make s ### Device Alert: "Station Signal is Low" Signal Low -When the RF connection with the Weather Station is weak, the WG1200 Gateway will display "Station Signal is Low" resulting to [Data Gaps](/project/rewards-troubleshooting#weather-data-gaps) and reduced Rewards. +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. @@ -64,7 +62,7 @@ This message is displayed when the weather station reports values that are out o - 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-bundle/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. +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). @@ -85,7 +83,7 @@ Replace the batteries of the weather station. Make sure you use lithium non-rech 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-bundle/install-weather-station#best-practices-for-proper-station-installation). +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).
@@ -94,7 +92,7 @@ Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metal 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-bundle/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. +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.
@@ -123,7 +121,7 @@ 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-bundle/D1-connect-and-claim#connect-wg1200-gateway-to-wifi) if necessary to verify. +- 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). @@ -149,7 +147,7 @@ It might take some time and attempts for it to connect. Please make sure that yo ## GPS Location ### Location not verified -You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/project/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. +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. diff --git a/docs/wxm-devices/deployment-examples.mdx b/docs/wxm-devices/deployment-examples.mdx index 8c784424..3d87c689 100644 --- a/docs/wxm-devices/deployment-examples.mdx +++ b/docs/wxm-devices/deployment-examples.mdx @@ -1,9 +1,7 @@ --- -id: deployment-examples title: Deployment Examples hide_title: true sidebar_label: Deployment Examples -slug: /deployment-examples --- import useBaseUrl from "@docusaurus/useBaseUrl"; diff --git a/docs/wxm-devices/helium-bundle/helium-assemble.mdx b/docs/wxm-devices/helium/assemble.mdx similarity index 98% rename from docs/wxm-devices/helium-bundle/helium-assemble.mdx rename to docs/wxm-devices/helium/assemble.mdx index 9fe194c0..97ad6ef0 100644 --- a/docs/wxm-devices/helium-bundle/helium-assemble.mdx +++ b/docs/wxm-devices/helium/assemble.mdx @@ -1,8 +1,6 @@ --- -id: helium-assemble title: Assembling WS2000 Weather Station sidebar_label: Installation Instructions -slug: /wxm-devices/helium-bundle/helium-assemble --- import useBaseUrl from "@docusaurus/useBaseUrl"; diff --git a/docs/wxm-devices/helium-bundle/helium-connect-and-claim.mdx b/docs/wxm-devices/helium/connect-and-claim.mdx similarity index 93% rename from docs/wxm-devices/helium-bundle/helium-connect-and-claim.mdx rename to docs/wxm-devices/helium/connect-and-claim.mdx index 7397c9b4..7e5a3ff5 100644 --- a/docs/wxm-devices/helium-bundle/helium-connect-and-claim.mdx +++ b/docs/wxm-devices/helium/connect-and-claim.mdx @@ -1,8 +1,6 @@ --- -id: helium-connect-and-claim title: Connect and Claim the Station sidebar_label: Station Claiming -slug: /wxm-devices/helium-bundle/helium-connect-and-claim --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -15,7 +13,7 @@ In this chapter, you will find guidance to set up the WeatherXM Helium station. 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-bundle/helium-connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +1. The [WeatherXM](/wxm-devices/helium/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. ## Step by Step Instructions @@ -124,7 +122,7 @@ Given the location of installation you defined in the previous step, we’ve sel 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-bundle/helium-update-firmware/). +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. diff --git a/docs/wxm-devices/helium-bundle/helium-contents.mdx b/docs/wxm-devices/helium/contents.mdx similarity index 94% rename from docs/wxm-devices/helium-bundle/helium-contents.mdx rename to docs/wxm-devices/helium/contents.mdx index cf6b8e64..7327f005 100644 --- a/docs/wxm-devices/helium-bundle/helium-contents.mdx +++ b/docs/wxm-devices/helium/contents.mdx @@ -1,8 +1,6 @@ --- -id: helium-contents title: Box Contents WeatherXM Helium Station (WS2000) sidebar_label: Box Contents -slug: /wxm-devices/helium-bundle/helium-contents --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -75,7 +73,7 @@ The weather station is responsible for the collection of measurements of tempera :::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-bundle/helium-install-weather-station). +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). :::
diff --git a/docs/wxm-devices/helium-bundle/helium-install-weather-station.mdx b/docs/wxm-devices/helium/install-weather-station.mdx similarity index 95% rename from docs/wxm-devices/helium-bundle/helium-install-weather-station.mdx rename to docs/wxm-devices/helium/install-weather-station.mdx index 140479dd..eae58c91 100644 --- a/docs/wxm-devices/helium-bundle/helium-install-weather-station.mdx +++ b/docs/wxm-devices/helium/install-weather-station.mdx @@ -1,8 +1,6 @@ --- -id: helium-install-weather-station title: Installing WS2000 Weather station sidebar_label: Station Installation -slug: /wxm-devices/helium-bundle/helium-install-weather-station --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -10,7 +8,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ## 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-bundle/helium-install-weather-station#best-practices-for-proper-station-installation) +1. Location and spacing [Best practices for proper station installation](/wxm-devices/helium/install-weather-station#best-practices-for-proper-station-installation) :::caution @@ -26,7 +24,7 @@ The values of the various meteorological parameters measured by a weather statio and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: :::info -Don't sure for your installation point? Check deployment examples [here](/deployment-examples). +Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). ::: ### Pole's Height diff --git a/docs/wxm-devices/helium-bundle/wxm-ws2000-introduction.mdx b/docs/wxm-devices/helium/introduction.mdx similarity index 90% rename from docs/wxm-devices/helium-bundle/wxm-ws2000-introduction.mdx rename to docs/wxm-devices/helium/introduction.mdx index 74d81250..1f3d082a 100644 --- a/docs/wxm-devices/helium-bundle/wxm-ws2000-introduction.mdx +++ b/docs/wxm-devices/helium/introduction.mdx @@ -1,10 +1,6 @@ --- -id: wxm-ws2000-introduction title: Introduction WeatherXM Helium station (WS2000) -hide_title: false sidebar_label: Introduction -slug: /wxm-devices/helium-bundle/wxm-ws2000-introduction -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -30,7 +26,7 @@ Let's see what are the necessary steps in order to properly assemble, install, c Make sure that everything is in order and you're all set to proceed with station assembly. -View Contents +View Contents ### Assemble your weather station @@ -38,21 +34,21 @@ Make sure that everything is in order and you're all set to proceed with 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 +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 +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 +View Station Installation Instructions ### Add your ERC20 compatible wallet @@ -60,7 +56,7 @@ This is one of the most important steps, as proper installation is key in order 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 +View Wallet Addition Instructions ## Features and Specifications diff --git a/docs/wxm-devices/helium-bundle/helium-maintenance.mdx b/docs/wxm-devices/helium/maintenance.mdx similarity index 82% rename from docs/wxm-devices/helium-bundle/helium-maintenance.mdx rename to docs/wxm-devices/helium/maintenance.mdx index e199729c..a8198993 100644 --- a/docs/wxm-devices/helium-bundle/helium-maintenance.mdx +++ b/docs/wxm-devices/helium/maintenance.mdx @@ -1,8 +1,6 @@ --- -id: helium-maintenance title: Maintenance of WeatherXM Helium station (WS2000) sidebar_label: Maintenance -slug: /wxm-devices/wifi-helium-bundle/helium-maintenance --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -28,7 +26,7 @@ The sketch below shows how to open the rain gauge. 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-bundle/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. +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 diff --git a/docs/wxm-devices/helium-bundle/helium-troubleshooting.mdx b/docs/wxm-devices/helium/troubleshooting.mdx similarity index 94% rename from docs/wxm-devices/helium-bundle/helium-troubleshooting.mdx rename to docs/wxm-devices/helium/troubleshooting.mdx index 491d4bfb..cec824f9 100644 --- a/docs/wxm-devices/helium-bundle/helium-troubleshooting.mdx +++ b/docs/wxm-devices/helium/troubleshooting.mdx @@ -1,8 +1,6 @@ --- -id: helium-troubleshooting title: Troubleshooting of WeatherXM Helium station (WS2000) sidebar_label: Troubleshooting -slug: /helium-bundle/helium-troubleshooting --- import Tabs from "@theme/Tabs"; @@ -15,7 +13,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ### The updating process lasts forever -If the process hangs and does not proceed or if pairing fails, try a [factory reset](/helium-bundle/helium-troubleshooting#factory-reset). +If the process hangs and does not proceed or if pairing fails, try a [factory reset](/wxm-devices/helium/troubleshooting#factory-reset).
@@ -25,7 +23,7 @@ If the process hangs and does not proceed or if pairing fails, try a [factory re -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](/helium-bundle/helium-troubleshooting#factory-reset) and try again. +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. @@ -49,7 +47,7 @@ Your station reports its location a few times per day depending on network and b
### Location not verified -You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/project/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. +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. diff --git a/docs/wxm-devices/helium-bundle/helium-firmware-updade.mdx b/docs/wxm-devices/helium/update-firmware.mdx similarity index 92% rename from docs/wxm-devices/helium-bundle/helium-firmware-updade.mdx rename to docs/wxm-devices/helium/update-firmware.mdx index 0d575423..8d58ea51 100644 --- a/docs/wxm-devices/helium-bundle/helium-firmware-updade.mdx +++ b/docs/wxm-devices/helium/update-firmware.mdx @@ -1,8 +1,6 @@ --- -id: helium-update-firmware title: Update Firmware sidebar_label: Update Firmware -slug: /wxm-devices/helium-bundle/helium-update-firmware --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -65,7 +63,7 @@ Make sure you don't move away from your station as you might lose bluetooth conn 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"](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). +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). diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-assemble.mdx b/docs/wxm-devices/m5/assemble.mdx similarity index 96% rename from docs/wxm-devices/wifi-m5-bundle/m5-assemble.mdx rename to docs/wxm-devices/m5/assemble.mdx index 9b8c9a6d..14dfbb6c 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-assemble.mdx +++ b/docs/wxm-devices/m5/assemble.mdx @@ -1,8 +1,6 @@ --- -id: m5-assemble title: Assembling WS1000 Weather Station sidebar_label: Installation Instructions -slug: /wxm-devices/wifi-m5-bundle/assemble-m5 --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -112,6 +110,6 @@ The U-bolts and the metal plate are used to support the mounting of the outdoor 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/wifi-m5-bundle/install-weather-station#mounting-the-outdoor-sensor)). +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/docs/wxm-devices/wifi-m5-bundle/m5-connect-and-claim.mdx b/docs/wxm-devices/m5/connect-and-claim.mdx similarity index 96% rename from docs/wxm-devices/wifi-m5-bundle/m5-connect-and-claim.mdx rename to docs/wxm-devices/m5/connect-and-claim.mdx index bfdcdf6f..53a45c18 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-connect-and-claim.mdx +++ b/docs/wxm-devices/m5/connect-and-claim.mdx @@ -1,8 +1,6 @@ --- -id: m5-connect-and-claim title: Connect and Claim the Gateway sidebar_label: Gateway Claiming -slug: /wxm-devices/wifi-m5-bundle/m5-connect-and-claim --- import Tabs from "@theme/Tabs"; @@ -31,7 +29,7 @@ In this chapter, you will find guidance to set up the WG1000 Gateway. 1. The station must be fully assembled (parts and batteries). 1. A working smartphone with connection to the internet. -1. The [WeatherXM](//wxm-devices/wifi-m5-bundle/m5-connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +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.
@@ -258,7 +256,7 @@ 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"](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). +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! diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-contents.mdx b/docs/wxm-devices/m5/contents.mdx similarity index 97% rename from docs/wxm-devices/wifi-m5-bundle/m5-contents.mdx rename to docs/wxm-devices/m5/contents.mdx index aaade3e7..f936833f 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-contents.mdx +++ b/docs/wxm-devices/m5/contents.mdx @@ -1,8 +1,6 @@ --- -id: m5-contents title: Box Contents of M5 bundle (WB1000) sidebar_label: Box Contents -slug: /wxm-devices/wifi-m5-bundle/m5-contents --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -87,7 +85,7 @@ The outdoor sensor is responsible for: 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/wifi-m5-bundle/install-weather-station). +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. diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-install-weather-station.mdx b/docs/wxm-devices/m5/install-weather-station.mdx similarity index 95% rename from docs/wxm-devices/wifi-m5-bundle/m5-install-weather-station.mdx rename to docs/wxm-devices/m5/install-weather-station.mdx index 5d07f103..7f389816 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-install-weather-station.mdx +++ b/docs/wxm-devices/m5/install-weather-station.mdx @@ -1,8 +1,6 @@ --- -id: m5-install-weather-station title: Installing WS1000 Weather Station sidebar_label: Station Installation -slug: /wxm-devices/wifi-m5-bundle/install-weather-station --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -11,7 +9,7 @@ import Link from "@docusaurus/Link"; ## 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) +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. @@ -26,7 +24,7 @@ The values of the various meteorological parameters measured by a weather statio and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: :::info -Don't sure for your installation point? Check deployment examples [here](/deployment-examples). +Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). ::: ### Pole's Height diff --git a/docs/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction.mdx b/docs/wxm-devices/m5/introduction.mdx similarity index 87% rename from docs/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction.mdx rename to docs/wxm-devices/m5/introduction.mdx index 3ee2283e..02f431c8 100644 --- a/docs/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction.mdx +++ b/docs/wxm-devices/m5/introduction.mdx @@ -1,10 +1,6 @@ --- -id: wxm-ws1000-introduction title: Introduction of M5 bundle (WB1000) -hide_title: false sidebar_label: Introduction -slug: /wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -29,31 +25,31 @@ Let's see what are the necessary steps in order to properly assemble, install, c Make sure that everything is in order and you're all set to proceed with station assembly. -View Contents +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 +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 +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 +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 +View Wallet Addition Instructions ## Features and Specifications diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-maintenance.mdx b/docs/wxm-devices/m5/maintenance.mdx similarity index 84% rename from docs/wxm-devices/wifi-m5-bundle/m5-maintenance.mdx rename to docs/wxm-devices/m5/maintenance.mdx index 26d1c0ec..9ee5635b 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-maintenance.mdx +++ b/docs/wxm-devices/m5/maintenance.mdx @@ -1,8 +1,6 @@ --- -id: m5-maintenance title: Maintenance of WS1000 Weather Station sidebar_label: Maintenance -slug: /wxm-devices/wifi-m5-bundle/m5-maintenance --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -30,7 +28,7 @@ The sketch below shows how to open the rain gauge. 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/wifi-m5-bundle/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. +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 diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-troubleshooting.mdx b/docs/wxm-devices/m5/troubleshooting.mdx similarity index 95% rename from docs/wxm-devices/wifi-m5-bundle/m5-troubleshooting.mdx rename to docs/wxm-devices/m5/troubleshooting.mdx index 6a3b85f4..9ed073af 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-troubleshooting.mdx +++ b/docs/wxm-devices/m5/troubleshooting.mdx @@ -1,8 +1,6 @@ --- -id: m5-troubleshooting title: Troubleshooting of M5 bundle (WB1000) sidebar_label: Troubleshooting -slug: /wifi-m5-bundle/m5-troubleshooting --- import Tabs from "@theme/Tabs"; @@ -13,9 +11,9 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; ### 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/wifi-m5-bundle/m5-connect-and-claim#change-frequency-optional)) +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/wifi-m5-bundle/m5-contents#outdoor-weather-station)) for flashing. +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. @@ -43,14 +41,14 @@ The solution may be as simple as powering down and up the WG1000 Gateway. Make s 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/wifi-m5-bundle/install-weather-station#best-practices-for-proper-station-installation)). +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/wifi-m5-bundle/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. +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. @@ -120,7 +118,7 @@ And then proceed to the following steps: 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](/project/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. +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. diff --git a/docs/wxm-devices/wifi-m5-bundle/m5-usb-flasher.mdx b/docs/wxm-devices/m5/usb-flasher.mdx similarity index 99% rename from docs/wxm-devices/wifi-m5-bundle/m5-usb-flasher.mdx rename to docs/wxm-devices/m5/usb-flasher.mdx index 798f8339..2b38436b 100644 --- a/docs/wxm-devices/wifi-m5-bundle/m5-usb-flasher.mdx +++ b/docs/wxm-devices/m5/usb-flasher.mdx @@ -1,7 +1,5 @@ --- -id: m5-usb-flasher title: Updating Your WXM-M5 Firmware with the Flasher Tool -slug: /wxm-devices/wifi-m5-bundle/m5-usb-flasher --- import useBaseUrl from "@docusaurus/useBaseUrl"; diff --git a/docs/wxm-devices/pulse-bundle/assemble-weather-station.mdx b/docs/wxm-devices/pulse/assemble.mdx similarity index 96% rename from docs/wxm-devices/pulse-bundle/assemble-weather-station.mdx rename to docs/wxm-devices/pulse/assemble.mdx index dcb2ce83..c6ca6938 100644 --- a/docs/wxm-devices/pulse-bundle/assemble-weather-station.mdx +++ b/docs/wxm-devices/pulse/assemble.mdx @@ -1,8 +1,6 @@ --- -id: assemble-weather-station title: Assembling WS1001 Weather Station sidebar_label: Installation Instructions -slug: /wxm-devices/pulse-bundle/assemble-weather-station --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -112,4 +110,4 @@ The U-bolts and the metal plate are used to support the mounting of the outdoor 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/pulse-bundle/install-weather-station#mounting-the-outdoor-sensor). +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/pulse/install-weather-station#mounting-the-outdoor-sensor). diff --git a/docs/wxm-devices/pulse-bundle/connect-and-claim.mdx b/docs/wxm-devices/pulse/connect-and-claim.mdx similarity index 95% rename from docs/wxm-devices/pulse-bundle/connect-and-claim.mdx rename to docs/wxm-devices/pulse/connect-and-claim.mdx index d746a98f..1f0063d6 100644 --- a/docs/wxm-devices/pulse-bundle/connect-and-claim.mdx +++ b/docs/wxm-devices/pulse/connect-and-claim.mdx @@ -1,8 +1,6 @@ --- -id: connect-and-claim title: Connect and Claim the Gateway sidebar_label: Gateway Claiming -slug: /wxm-devices/pulse-bundle/connect-and-claim --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -21,7 +19,7 @@ In this chapter, you will find guidance to set up the WG3000 Gateway. 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-bundle/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone. +1. The [WeatherXM](/wxm-devices/pulse/connect-and-claim#download-weatherxm-app-and-login) Application installed on your smartphone.
@@ -154,7 +152,7 @@ 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"](/wallet/add-edit-wallet-address#how-to-create-wallet-on-metamask). +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! diff --git a/docs/wxm-devices/pulse-bundle/contents.mdx b/docs/wxm-devices/pulse/contents.mdx similarity index 96% rename from docs/wxm-devices/pulse-bundle/contents.mdx rename to docs/wxm-devices/pulse/contents.mdx index fd0bc228..bf614558 100644 --- a/docs/wxm-devices/pulse-bundle/contents.mdx +++ b/docs/wxm-devices/pulse/contents.mdx @@ -1,8 +1,6 @@ --- -id: contents title: Box Contents of Pulse bundle (WB3000) sidebar_label: Box Contents -slug: /wxm-devices/pulse-bundle/contents --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -76,7 +74,7 @@ The outdoor sensor is responsible for: 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-bundle/install-weather-station). +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. diff --git a/docs/wxm-devices/pulse-bundle/install-weather-station.mdx b/docs/wxm-devices/pulse/install-weather-station.mdx similarity index 94% rename from docs/wxm-devices/pulse-bundle/install-weather-station.mdx rename to docs/wxm-devices/pulse/install-weather-station.mdx index f78775e1..da77eb44 100644 --- a/docs/wxm-devices/pulse-bundle/install-weather-station.mdx +++ b/docs/wxm-devices/pulse/install-weather-station.mdx @@ -1,8 +1,6 @@ --- -id: install-weather-station title: Installing WS1001 Weather station sidebar_label: Station Installation -slug: /wxm-devices/pulse-bundle/install-weather-station --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -11,7 +9,7 @@ import Link from "@docusaurus/Link"; ## 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) +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. @@ -26,7 +24,7 @@ The values of the various meteorological parameters measured by a weather statio and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled: :::info -Don't sure for your installation point? Check deployment examples [here](/deployment-examples). +Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples). ::: ### Pole's Height diff --git a/docs/wxm-devices/pulse-bundle/introduction.mdx b/docs/wxm-devices/pulse/introduction.mdx similarity index 88% rename from docs/wxm-devices/pulse-bundle/introduction.mdx rename to docs/wxm-devices/pulse/introduction.mdx index 2f14413f..86427921 100644 --- a/docs/wxm-devices/pulse-bundle/introduction.mdx +++ b/docs/wxm-devices/pulse/introduction.mdx @@ -1,10 +1,6 @@ --- -id: introduction title: Introduction of Pulse bundle (WB3000) -hide_title: false sidebar_label: Introduction -slug: /wxm-devices/pulse-bundle/introduction -hide_table_of_contents: false --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -30,31 +26,31 @@ Let's see what are the necessary steps in order to properly assemble, install, c Make sure that everything is in order and you're all set to proceed with station assembly. -View Contents +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 +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 +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 +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 +View Wallet Addition Instructions ## Features and Specifications diff --git a/docs/wxm-devices/pulse-bundle/maintenance.mdx b/docs/wxm-devices/pulse/maintenance.mdx similarity index 86% rename from docs/wxm-devices/pulse-bundle/maintenance.mdx rename to docs/wxm-devices/pulse/maintenance.mdx index 7ca42560..fad0797f 100644 --- a/docs/wxm-devices/pulse-bundle/maintenance.mdx +++ b/docs/wxm-devices/pulse/maintenance.mdx @@ -1,8 +1,6 @@ --- -id: maintenance title: Maintenance of Pulse bundle (WB3000) sidebar_label: Maintenance -slug: /wxm-devices/pulse-bundle/maintenance --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -32,7 +30,7 @@ The sketch below shows how to open the rain gauge. 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-bundle/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. +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 diff --git a/docs/wxm-devices/pulse-bundle/troubleshooting.mdx b/docs/wxm-devices/pulse/troubleshooting.mdx similarity index 90% rename from docs/wxm-devices/pulse-bundle/troubleshooting.mdx rename to docs/wxm-devices/pulse/troubleshooting.mdx index 71b5f21c..69205c0c 100644 --- a/docs/wxm-devices/pulse-bundle/troubleshooting.mdx +++ b/docs/wxm-devices/pulse/troubleshooting.mdx @@ -1,8 +1,6 @@ --- -id: troubleshooting title: Troubleshooting of Pulse Bundle (WB3000) sidebar_label: Troubleshooting -slug: /wxm-devices/pulse-bundle/troubleshooting --- import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -15,8 +13,8 @@ If the error message "Data gaps" is displayed on the mobile app, the WG300 Gatew This can be due to a variety of reasons. Here are some steps to troubleshoot the issue: -First make sure you WG3000 Gateway frequency matches your weather station (see [Change frequency](/wxm-devices/pulse-bundle/connect-and-claim#change-frequency-optional) -Check the LED on the weather station (see [Reset Button and LED Indicator](/wxm-devices/pulse-bundle/assemble-weather-station) for flashing. +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. @@ -56,7 +54,7 @@ Replace the batteries of the weather station. Make sure you use lithium non-rech 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-bundle/install-weather-station#best-practices-for-proper-station-installation). +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).
@@ -65,7 +63,7 @@ Also make sure that the weather station is mounted on a 2m/6.5ft (or more) metal 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-bundle/install-weather-station#best-practices-for-proper-station-installation) for guidelines about the installation of the weather station. +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.
@@ -84,7 +82,7 @@ For now we present only the absolute pressure and not the Mean Sea Level Pressur ## GPS Location ### Location not verified -You receive a "location not verified" error on your mobile app when the [Proof of Location (PoL) mechanism](/project/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. +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. diff --git a/docusaurus.config.js b/docusaurus.config.js index 0221f607..dbcf0695 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -3,133 +3,112 @@ require("dotenv").config(); import remarkMath from "remark-math"; import rehypeKatex from "rehype-katex"; + /** @type {import('@docusaurus/types').Config} */ const config = { - title: "WeatherXM Docs", - tagline: "WeatherXM Documentation Page", - url: "https://docs.weatherxm.com", - baseUrl: "/", - onBrokenLinks: "throw", - onBrokenMarkdownLinks: "warn", - favicon: "img/favicon/favicon.ico", - organizationName: "WeatherXM", // Usually your GitHub org/user name. - projectName: "docs", // Usually your repo name. - deploymentBranch: "gh-pages", - trailingSlash: false, - - plugins: [ - path.resolve(__dirname, "plugins/docusaurus-plugin-hotjar"), - [ - "@docusaurus/plugin-client-redirects", - { - redirects: [ - { - to: "/rewards/how-to-join-arbitrum-and-see-your-tokens", - from: "/wallet/how-to-join-arbitrum-and-see-your-tokens", - }, - { - to: "/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction#features-and-specifications", - from: "/m5-specs", - }, - { - to: "/wxm-devices/helium-bundle/wxm-ws2000-introduction#features-and-specifications", - from: "/helium-specs", - }, - { - to: "/wxm-devices/D1-bundle/D1-bundle-introduction#features-and-specifications", - from: "/wxm-devices/D1-bundle/D1-specs", - } - ] - } - ] - ], - - presets: [ - [ - "@docusaurus/preset-classic", - { - gtag: { - trackingID: "G-E38CY3JRM3", - }, - docs: { - sidebarPath: require.resolve("./sidebars.js"), - routeBasePath: "/", - // Please change this to your repo. - editUrl: "https://github.com/WeatherXM/docs/blob/main", - remarkPlugins: [remarkMath], - rehypePlugins: [rehypeKatex], - }, - theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - }, - ], - ], - - themeConfig: { - hotjar: { - applicationId: 2542811, + title: "WeatherXM Docs", + tagline: "WeatherXM Documentation Page", + url: "https://docs.weatherxm.com", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + favicon: "img/favicon/favicon.ico", + organizationName: "WeatherXM", // Usually your GitHub org/user name. + projectName: "docs", // Usually your repo name. + deploymentBranch: "gh-pages", + trailingSlash: false, + plugins: [ + path.resolve(__dirname, "plugins/docusaurus-plugin-hotjar"), + [ + "@docusaurus/plugin-client-redirects", + { + redirects: require("./redirects.js") + } + ] + ], + presets: [ + [ + "@docusaurus/preset-classic", + { + gtag: { + trackingID: "G-E38CY3JRM3" }, - colorMode: { - defaultMode: "light", - disableSwitch: false, - respectPrefersColorScheme: true, + docs: { + sidebarPath: require.resolve("./sidebars.js"), + routeBasePath: "/", + // Please change this to your repo. + editUrl: "https://github.com/WeatherXM/docs/blob/main", + remarkPlugins: [remarkMath], + rehypePlugins: [rehypeKatex] }, - navbar: { - logo: { - alt: "WeatherXM", - src: "img/wxm-logo-wide-notagline.svg", - srcDark: "img/wxm-logo-wide-notagline-white.svg", - }, - items: [ - { - href: "https://explorer.weatherxm.com/", - label: "Explorer", - position: "right", - }, - { - href: "https://claim.weatherxm.com/", - label: "Claim Rewards", - position: "right", - }, - { - href: "https://weatherxm.com/whitepaper", - label: "Whitepaper", - position: "right", - }, - { - href: "https://github.com/WeatherXM/docs", - label: "GitHub", - position: "right", - }, - { - href: "https://support.weatherxm.com", - label: "Help Center", - position: "right", - }, - { - href: "https://shop.weatherxm.com", - label: "Shop", - position: "right", - id: "docs", - }, - ], - }, - footer: { - copyright: `Copyright © ${new Date().getFullYear()} WeatherXM`, - style: "light", + theme: { + customCss: require.resolve("./src/css/custom.css") }, + }, + ], + ], + themeConfig: { + hotjar: { + applicationId: 2542811 }, - -stylesheets: [ - { - href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css', - type: 'text/css', - integrity: - 'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM', - crossorigin: 'anonymous', + colorMode: { + defaultMode: "light", + disableSwitch: false, + respectPrefersColorScheme: true }, - ], + navbar: { + logo: { + alt: "WeatherXM", + src: "img/wxm-logo-wide-notagline.svg", + srcDark: "img/wxm-logo-wide-notagline-white.svg" + }, + items: [ + { + href: "https://explorer.weatherxm.com/", + label: "Explorer", + position: "right" + }, + { + href: "https://claim.weatherxm.com/", + label: "Claim Rewards", + position: "right" + }, + { + href: "https://weatherxm.com/whitepaper", + label: "Whitepaper", + position: "right" + }, + { + href: "https://github.com/WeatherXM/docs", + label: "GitHub", + position: "right" + }, + { + href: "https://support.weatherxm.com", + label: "Help Center", + position: "right" + }, + { + href: "https://shop.weatherxm.com", + label: "Shop", + position: "right", + id: "docs" + }, + ], + }, + footer: { + copyright: `Copyright © ${new Date().getFullYear()} WeatherXM`, + style: "light" + }, + }, + stylesheets: [ + { + href: "https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css", + type: "text/css", + integrity: "sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM", + crossorigin: "anonymous" + } + ] }; module.exports = config; diff --git a/redirects.js b/redirects.js new file mode 100644 index 00000000..5553f5e6 --- /dev/null +++ b/redirects.js @@ -0,0 +1,190 @@ +module.exports = [ + { + to: "/rewards/how-to-join-arbitrum-and-see-your-tokens", + from: "/wallet/how-to-join-arbitrum-and-see-your-tokens" + }, + { + to: "/wxm-devices/m5/introduction#features-and-specifications", + from: "/m5-specs" + }, + { + to: "/wxm-devices/helium/introduction#features-and-specifications", + from: "/helium-specs" + }, + { + to: "/wxm-devices/d1/introduction#features-and-specifications", + from: "/wxm-devices/D1-bundle/D1-specs" + }, + { + to: "/mobile-app/wallet/add-edit-wallet-address", + from: "/wallet/add-edit-wallet-address" + }, + { + to: "/mobile-app/change-password", + from: "/account/change-password" + }, + { + to: "/mobile-app/delete-account", + from: "/account/delete-account" + }, + { + to: "/rewards/cell-capacity", + from: "/project/cell-capacity" + }, + { + to: "/rewards/hardware-class", + from: "/project/hardware-class" + }, + { + to: "/rewards/proof-of-location", + from: "/project/proof-of-location" + }, + { + to: "/rewards/quality-of-data", + from: "/project/quality-of-data" + }, + { + to: "/rewards/reward-boosts", + from: "/project/reward-boosts" + }, + { + to: "/rewards/reward-mechanism", + from: "/reward-mechanism" + }, + { + to: "/rewards/rewards-claiming", + from: "/project/rewards-claiming" + }, + { + to: "/rewards/rewards-troubleshooting", + from: "/project/rewards-troubleshooting" + }, + { + to: "/faq", + from: "/faqs" + }, + { + to: "/wxm-devices/deployment-examples", + from: "/deployment-examples" + }, + { + to: "/wxm-devices/d1/introduction", + from: "/wxm-devices/D1-bundle/D1-bundle-introduction" + }, + { + to: "/wxm-devices/d1/contents", + from: "/wxm-devices/D1-bundle/D1-contents" + }, + { + to: "/wxm-devices/d1/assemble", + from: "/wxm-devices/D1-bundle/D1-assemble" + }, + { + to: "/wxm-devices/d1/install-weather-station", + from: "/wxm-devices/D1-bundle/install-weather-station" + }, + { + to: "/wxm-devices/d1/connect-and-claim", + from: "/wxm-devices/D1-bundle/D1-connect-and-claim" + }, + { + to: "/wxm-devices/d1/maintenance", + from: "/wxm-devices/D1-bundle/maintenance" + }, + { + to: "/wxm-devices/d1/troubleshooting", + from: "/wxm-devices/D1-bundle/D1-troubleshooting" + }, + { + to: "/wxm-devices/pulse/introduction", + from: "/wxm-devices/pulse-bundle/introduction" + }, + { + to: "/wxm-devices/pulse/contents", + from: "/wxm-devices/pulse-bundle/contents" + }, + { + to: "/wxm-devices/pulse/assemble", + from: "/wxm-devices/pulse-bundle/assemble-weather-station" + }, + { + to: "/wxm-devices/pulse/install-weather-station", + from: "/wxm-devices/pulse-bundle/install-weather-station" + }, + { + to: "/wxm-devices/pulse/connect-and-claim", + from: "/wxm-devices/pulse-bundle/connect-and-claim" + }, + { + to: "/wxm-devices/pulse/maintenance", + from: "/wxm-devices/pulse-bundle/maintenance" + }, + { + to: "/wxm-devices/pulse/troubleshooting", + from: "/wxm-devices/pulse-bundle/troubleshooting" + }, + { + to: "/wxm-devices/helium/introduction", + from: "/wxm-devices/helium-bundle/wxm-ws2000-introduction" + }, + { + to: "/wxm-devices/helium/contents", + from: "/wxm-devices/helium-bundle/helium-contents" + }, + { + to: "/wxm-devices/helium/assemble", + from: "/wxm-devices/helium-bundle/helium-assemble" + }, + { + to: "/wxm-devices/helium/connect-and-claim", + from: "/wxm-devices/helium-bundle/helium-connect-and-claim" + }, + { + to: "/wxm-devices/helium/update-firmware", + from: "/wxm-devices/helium-bundle/helium-update-firmware" + }, + { + to: "/wxm-devices/helium/install-weather-station", + from: "/wxm-devices/helium-bundle/helium-install-weather-station" + }, + { + to: "/wxm-devices/helium/maintenance", + from: "/wxm-devices/helium-bundle/helium-maintenance" + }, + { + to: "/wxm-devices/helium/troubleshooting", + from: "/wxm-devices/helium-bundle/helium-troubleshooting" + }, + { + to: "/wxm-devices/m5/introduction", + from: "/wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction" + }, + { + to: "/wxm-devices/m5/contents", + from: "/wxm-devices/wifi-m5-bundle/m5-contents" + }, + { + to: "/wxm-devices/m5/assemble", + from: "/wxm-devices/wifi-m5-bundle/m5-assemble" + }, + { + to: "/wxm-devices/m5/connect-and-claim", + from: "/wxm-devices/wifi-m5-bundle/m5-connect-and-claim" + }, + { + to: "/wxm-devices/m5/install-weather-station", + from: "/wxm-devices/wifi-m5-bundle/m5-install-weather-station" + }, + { + to: "/wxm-devices/m5/maintenance", + from: "/wxm-devices/wifi-m5-bundle/m5-maintenance" + }, + { + to: "/wxm-devices/m5/troubleshooting", + from: "/wxm-devices/wifi-m5-bundle/m5-troubleshooting" + }, + { + to: "/wxm-devices/m5/usb-flasher", + from: "/wxm-devices/wifi-m5-bundle/m5-usb-flasher" + } +] diff --git a/sidebars.js b/sidebars.js index f61a75f0..f1aae402 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,109 +1,107 @@ module.exports = { docs: [ "home", - "introduction", + "introduction", { type: "category", label: "Deploy a WeatherXM Device", items: [ - { - type: "category", - label: "M5 (WB1000)", - items: [ - "wxm-devices/wifi-m5-bundle/wxm-ws1000-introduction", - "wxm-devices/wifi-m5-bundle/m5-contents", - "wxm-devices/wifi-m5-bundle/m5-assemble", - "wxm-devices/wifi-m5-bundle/m5-install-weather-station", - "wxm-devices/wifi-m5-bundle/m5-connect-and-claim", - "wxm-devices/wifi-m5-bundle/m5-maintenance", - "wxm-devices/wifi-m5-bundle/m5-troubleshooting" - ], - collapsed: true, - }, - { - type: "category", - label: "Helium (WS2000)" , - items: [ - "wxm-devices/helium-bundle/wxm-ws2000-introduction", - "wxm-devices/helium-bundle/helium-contents", - "wxm-devices/helium-bundle/helium-assemble", - "wxm-devices/helium-bundle/helium-connect-and-claim", - "wxm-devices/helium-bundle/helium-update-firmware", - "wxm-devices/helium-bundle/helium-install-weather-station", - "wxm-devices/helium-bundle/helium-maintenance", - "wxm-devices/helium-bundle/helium-troubleshooting" - ], - collapsed: true, - - }, - { - type: "category", - label: "D1 (WB1200)", - items: [ - "wxm-devices/D1-bundle/D1-bundle-introduction", - "wxm-devices/D1-bundle/D1-contents", - "wxm-devices/D1-bundle/D1-assemble", - "wxm-devices/D1-bundle/install-weather-station", - "wxm-devices/D1-bundle/D1-connect-and-claim", - "wxm-devices/D1-bundle/maintenance", - "wxm-devices/D1-bundle/D1-troubleshooting" - ], - collapsed: true, - }, - { - type: "category", - label: "Pulse (WB3000)", - items: [ - "wxm-devices/pulse-bundle/introduction", - "wxm-devices/pulse-bundle/contents", - "wxm-devices/pulse-bundle/assemble-weather-station", - "wxm-devices/pulse-bundle/install-weather-station", - "wxm-devices/pulse-bundle/connect-and-claim", - "wxm-devices/pulse-bundle/maintenance", - "wxm-devices/pulse-bundle/troubleshooting" - ], - collapsed: true, - }, - "wxm-devices/deployment-examples", + { + type: "category", + label: "M5 (WB1000)", + items: [ + "wxm-devices/m5/introduction", + "wxm-devices/m5/contents", + "wxm-devices/m5/assemble", + "wxm-devices/m5/install-weather-station", + "wxm-devices/m5/connect-and-claim", + "wxm-devices/m5/maintenance", + "wxm-devices/m5/troubleshooting" + ], + collapsed: true + }, + { + type: "category", + label: "Helium (WS2000)" , + items: [ + "wxm-devices/helium/introduction", + "wxm-devices/helium/contents", + "wxm-devices/helium/assemble", + "wxm-devices/helium/connect-and-claim", + "wxm-devices/helium/update-firmware", + "wxm-devices/helium/install-weather-station", + "wxm-devices/helium/maintenance", + "wxm-devices/helium/troubleshooting" + ], + collapsed: true + }, + { + type: "category", + label: "D1 (WB1200)", + items: [ + "wxm-devices/d1/introduction", + "wxm-devices/d1/contents", + "wxm-devices/d1/assemble", + "wxm-devices/d1/install-weather-station", + "wxm-devices/d1/connect-and-claim", + "wxm-devices/d1/maintenance", + "wxm-devices/d1/troubleshooting" + ], + collapsed: true + }, + { + type: "category", + label: "Pulse (WB3000)", + items: [ + "wxm-devices/pulse/introduction", + "wxm-devices/pulse/contents", + "wxm-devices/pulse/assemble", + "wxm-devices/pulse/install-weather-station", + "wxm-devices/pulse/connect-and-claim", + "wxm-devices/pulse/maintenance", + "wxm-devices/pulse/troubleshooting" + ], + collapsed: true + }, + "wxm-devices/deployment-examples", + ], + collapsed: true, + }, + { + type: "category", + label: "Rewards", + items: [ + "rewards/reward-mechanism", + "rewards/quality-of-data", + "rewards/proof-of-location", + "rewards/cell-capacity", + "rewards/hardware-class", + "rewards/reward-boosts", + "rewards/rewards-troubleshooting", + "rewards/rewards-claiming", + "rewards/how-to-join-arbitrum-and-see-your-tokens" ], - collapsed: true, + collapsed: true, }, - { - type: "category", - label: "Rewards", - items: [ - "rewards/reward-mechanism", - "rewards/quality-of-data", - "rewards/proof-of-location", - "rewards/cell-capacity", - "rewards/hardware-class", - "rewards/reward-boosts", - "rewards/rewards-troubleshooting", - "rewards/rewards-claiming", - "rewards/how-to-join-arbitrum-and-see-your-tokens" - ], - collapsed: true, - }, { - type: "category", - label: "Mobile App", - - items: [ - { - type: "category", - label: "Wallet", - items: [ - "wallet/add-edit-wallet-address" - ], - collapsed: true, - }, - "account/delete-account", - "account/change-password" - ], - collapsed: true, + type: "category", + label: "Mobile App", + items: [ + { + type: "category", + label: "Wallet", + items: [ + "mobile-app/wallet/add-edit-wallet-address" + ], + collapsed: true, + }, + "mobile-app/delete-account", + "mobile-app/change-password" + ], + collapsed: true, }, - "tokenomics", - "glossary/glossary", - "help-center/faqs" + "tokenomics", + "glossary", + "faq" ] };