Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FE-1131 Reuse best practices page and move WS1000 images to a new "ws1000" folder #152

Merged
merged 2 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/wxm-devices/d1/assemble.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ In order to properly deploy the weather station, you will need two (2) AA batter
### Assembling the wind sensor

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-wind-vane-cap-correct-false-position.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/wind-vane-cap-correct-false-position.svg")} />

:::caution
Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor.
:::
</div>

<div class="control">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-wind-vane-assembly.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/wind-vane-assembly.svg")} />
</div>
The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly)
and another that measures the wind direction (though wind vane).
Expand All @@ -54,7 +54,7 @@ However, the wind vane’s movement has a small amount of friction, which assist
### Installing batteries

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/battery-installation.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/battery-installation.svg")} />
<section>

Use a screwdriver to open the battery compartment and insert 2 AA batteries.
Expand Down Expand Up @@ -89,7 +89,7 @@ While not mandatory, we strongly recommend the installation of the battery pack
2. Improved Accessibility: The battery pack includes an extension cable (~3 meters), providing easier access for battery replacement when needed.

<div class="control">
<img src={useBaseUrl("/img/wxm-devices/ws-1001/battery-pack.png")} />
<img src={useBaseUrl("/img/wxm-devices/ws1001/battery-pack.png")} />
</div>

1. Open the Battery Pack: Begin by pulling the clip on the side of the battery pack to open it.
Expand Down Expand Up @@ -118,7 +118,7 @@ make sure that the batteries are inserted fully and in the correct way.
### Remove Sticker from Solar Panel

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/remove-sticker.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/remove-sticker.svg")} />
<div>
<p>
Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off.
Expand Down Expand Up @@ -150,16 +150,16 @@ Each weather station comes with the following bird spike components:
1. Prepare the Spike Holders: Insert a metal zip tie through each spike holder, ensuring that the holes are facing upward.
2. Insert the Spikes: Place a metal spike into each hole on the spike holder.
<div class="control">
<img src={useBaseUrl("img/wxm-devices/ws-1001/bird-spikes-1.png")} />
<img src={useBaseUrl("img/wxm-devices/ws1001/bird-spikes-1.png")} />
</div>
3. Attach the Spike Holders to the Rain Cup: Wrap the zip tie around the rim of the rain cup and tighten it securely to prevent the spike holders from loosening or falling off. For easier installation,
it is recommended to first remove the rain cup by twisting it lightly before attaching the spike holders.
<div class="control">
<img src={useBaseUrl("img/wxm-devices/ws-1001/bird-spikes-2.png")} />
<img src={useBaseUrl("img/wxm-devices/ws1001/bird-spikes-2.png")} />
</div>
4. Secure the Metal Zip Tie: Carefully secure the metal zip tie on top of the rain cup to ensure the spike holders are firmly in place and will not fall off.
<div class="control">
<img src={useBaseUrl("img/wxm-devices/ws-1001/bird-spikes-3.png")} />
<img src={useBaseUrl("img/wxm-devices/ws1001/bird-spikes-3.png")} />
</div>


Expand All @@ -168,7 +168,7 @@ Each weather station comes with the following bird spike components:
### Installing U-bolts and metal plate

<div class="control">
<img src={useBaseUrl("img/wxm-devices/m5/u-bracket-installation.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/u-bracket-installation.svg")} />
</div>

#### U-bracket installation
Expand Down
2 changes: 1 addition & 1 deletion docs/wxm-devices/d1/contents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The outdoor sensor is responsible for:
1. the wireless transmission of the data to the weather miner.

<div class="explanation two-columns">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-parts.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/parts.svg")} />
<div>
<h4>Components</h4>
<ol>
Expand Down
87 changes: 4 additions & 83 deletions docs/wxm-devices/d1/install-weather-station.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,104 +5,25 @@ sidebar_label: Station Installation

import useBaseUrl from "@docusaurus/useBaseUrl";
import Link from "@docusaurus/Link";
import InstallationBestPracticesWS100x from "../installation-best-practices-ws100x.mdx";

## 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 (<Link to="/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation">Best practices for proper station installation</Link>)
1. Location and spacing (<Link to="/wxm-devices/m5/install-weather-station#best-practices-for-proper-station-installation">Best Practices for Proper Station Installation</Link>)

:::caution
It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards.
:::

### Best Practices for Proper Station Installation

It is very important that your weather station collects quality measurements.
This turns the weather station into a powerful tool for yourself and WeatherXM.

The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles
and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled:

:::info
Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples).
:::

### Pole's Height
The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft.
This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal
or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft.

<div class="explanation horizontal">
<div class="images">
<img src={useBaseUrl("img/wxm-devices/m5/ground-height.svg")} />
<img src={useBaseUrl("img/wxm-devices/m5/roof-deployment.svg")} />
</div>
</div>

<hr/>

### Pole specifications

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/max-pole-diameter.svg")} />
<p>The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft.
This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal
or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft.</p>
</div>

<hr/>

### Tighten Pole
The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds.
This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements.
<div class="control">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-tighten-pole.svg")} />
</div>

<hr/>

### Installation Point

The pole together with the weather station should be placed in an installation point, which:

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

<section class="control">
<img src={useBaseUrl("img/wxm-devices/m5/away-from-heat-sources.svg")} />
</section>

<h4>2. Does not get in shadowed areas</h4>
Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item).
<section class="explanation horizontal">
<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/building-with-pool-in-roof.svg")} />
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-shadow-soft.svg")} />
</div>
</section>

<h4>3. Adequate Distance</h4>
Has a distance from any obstacles around, which 2-4 times larger than the height of the highest obstacle
(e.g., if the highest obstacle around the installation point is a 6-meter tree, ht=6m/20ft,
and the pole of the outdoor sensor is 2m/6.5ft, hp=2m/6.5ft, then the pole should be placed at a distance (dp) of 8-16m/26-52.5ft,
2 x (ht-hp) &#60; dp &#60; 4 x (ht-hp). In case the pole is placed on a building’s roof,
then the building’s height should be added to the pole’s height).
Note that in cases of obstacles with a height >8m/26ft, you should consider placing the outdoor sensor
at a distance 30 times the width and 15 times the height of the obstacles around.

:::note
All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible
while 3. is important for avoiding faulty precipitation and wind measurements.
:::
<InstallationBestPracticesWS100x />

<hr/>

## Mounting the outdoor sensor

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/pole-assembly.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/pole-assembly.svg")} />
<p>If this is the first time that you set up this outdoor sensor,
then you should make sure that all parts work properly before mounting the sensor on the pole outdoors.<br />
Thus, it is important that you are able to read all the measurements on the WG1200 Gateway's screen,
Expand Down
2 changes: 1 addition & 1 deletion docs/wxm-devices/d1/maintenance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It is important not to swing the rain gauge spoon during this process,
as the weather station will measure and record faulty precipitation.
The sketch below shows how to open the rain gauge.
<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/maintenance.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/maintenance.svg")} />
</div>

### Solar Panel
Expand Down
19 changes: 8 additions & 11 deletions docs/wxm-devices/helium/install-weather-station.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ 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/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
It is imperative that you properly install your weather station. This will create the necessary conditions for quality weather data collection, which are required for the purpose of the WeatherXM network and the resulting rewards. Faulty installation, will result in less to none WXM rewards.
:::

### Best practices for proper station installation
## Best Practices for Proper Station Installation

It is very important that your weather station collects quality measurements.
This turns the weather station into a powerful tool for yourself and WeatherXM.
Expand Down Expand Up @@ -44,9 +43,7 @@ The pole should be adequately tightened in order to prevent any pole oscillation
This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements.

<div class="control">
<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/helium/tighten-pole.svg")} />
</div>
</div>
<hr/>

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

<section class="control">
<img src={useBaseUrl("img/wxm-devices/helium/away-from-heat-sources.svg")} />
</section>
<section class="control">
<img src={useBaseUrl("img/wxm-devices/helium/away-from-heat-sources.svg")} />
</section>

<h4>2. Does not get in shadowed areas</h4>
Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item).
<section class="explanation horizontal">
<div class="images">
<img src={useBaseUrl("img/wxm-devices/m5/building-with-pool-in-roof.svg")} />
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-shadow-soft.svg")} />
<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/ws1000/building-with-pool-in-roof.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/shadow-soft.svg")} />
</div>
</section>

Expand Down
83 changes: 83 additions & 0 deletions docs/wxm-devices/installation-best-practices-ws100x.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import useBaseUrl from "@docusaurus/useBaseUrl";

## Best Practices for Proper Station Installation

It is very important that your weather station collects quality measurements.
This turns the weather station into a powerful tool for yourself and WeatherXM.

The values of the various meteorological parameters measured by a weather station can significantly differ depending on the obstacles
and the material of the surfaces existing around the sensors. For this reason, there is a series of criteria that should be fulfilled:

:::info
Don't sure for your installation point? Check deployment examples [here](/wxm-devices/deployment-examples).
:::

### Pole's Height
The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft.
This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal
or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft.

<div class="explanation horizontal">
<div class="images">
<img src={useBaseUrl("img/wxm-devices/ws1000/ground-height.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/roof-deployment.svg")} />
</div>
</div>

<hr/>

### Pole specifications

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/ws1000/max-pole-diameter.svg")} />
<p>The pole’s height, on which the weather station will be mounted, should be at least 2m/6.5ft.
This means that the weather station should be placed at least 2m/6.5ft above the ground and any other horizontal
or almost horizontal surface (e.g., roof) above the station. The maximum acceptable pole height is 5m/16.5ft.</p>
</div>

<hr/>

### Tighten Pole
The pole should be adequately tightened in order to prevent any pole oscillations in cases of strong winds.
This will prevent the rain gauge spoon from swinging and collecting faulty precipitation measurements.
<div class="control">
<img src={useBaseUrl("img/wxm-devices/ws1000/tighten-pole.svg")} />
</div>

<hr/>

### Installation Point

The pole together with the weather station should be placed in an installation point, which:

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

<section class="control">
<img src={useBaseUrl("img/wxm-devices/ws1000/away-from-heat-sources.svg")} />
</section>

<h4>2. Does not get in shadowed areas</h4>
Is not shadowed by any obstacle during the day (consider that the sun is typically higher during summer and lower during winter affecting the shadow caused by an item).
<section class="explanation horizontal">
<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/ws1000/building-with-pool-in-roof.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/shadow-soft.svg")} />
</div>
</section>

<h4>3. Adequate Distance</h4>
Has a distance from any obstacles around, which 2-4 times larger than the height of the highest obstacle
(e.g., if the highest obstacle around the installation point is a 6m/20ft tree, ht=6m/20ft,
and the pole of the outdoor sensor is 2m/6.5ft, hp=2m/6.5ft, then the pole should be placed at a distance (dp) of 8-16m/26-52.5ft,
2 x (ht-hp) &#60; dp &#60; 4 x (ht-hp). In case the pole is placed on a building’s roof,
then the building’s height should be added to the pole’s height).
Note that in cases of obstacles with a height >8m/26ft, you should consider placing the outdoor sensor
at a distance 30 times the width and 15 times the height of the obstacles around.

:::note
All of 1, 2 and 3 are important tips for measuring temperature and humidity as accurate as possible
while 3. is important for avoiding faulty precipitation and wind measurements.
:::
10 changes: 5 additions & 5 deletions docs/wxm-devices/m5/assemble.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ In order to properly deploy the weather station, you will need two (2) AA batter
### Assembling the wind sensor

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-wind-vane-cap-correct-false-position.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/wind-vane-cap-correct-false-position.svg")} />

:::caution
Be sure that you place the wind cup assembly on the shaft at the top part of the sensor. The wind vane should be placed on the shaft at the bottom of the sensor.
:::
</div>

<div class="control">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-wind-vane-assembly.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/wind-vane-assembly.svg")} />
<p>The wind sensor consists of a part that measures the wind speed (through wind speed cup assembly)
and another that measures the wind direction (though wind vane).
Both wind speed cup assembly and wind vane should be pushed onto the shafts on the part of the outdoor sensor,
Expand All @@ -54,7 +54,7 @@ However, the wind vane’s movement has a small amount of friction, which assist
### Installing batteries

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/battery-installation.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/battery-installation.svg")} />
<section>

Use a screwdriver to open the battery compartment and insert 2 AA batteries.
Expand Down Expand Up @@ -84,7 +84,7 @@ Batteries should not be installed backwards. This may permanently damage the out
### Remove Sticker from Solar Panel

<div class="explanation">
<img src={useBaseUrl("img/wxm-devices/m5/remove-sticker.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/remove-sticker.svg")} />
<div>
<p>
Remove the black sticker from the solar panel. If not, batteries will deplete and then the station will switch off.
Expand All @@ -101,7 +101,7 @@ In case that LED is permanently on or does not light up at all,make sure that th
### Installing U-bolts and metal plate

<div class="control">
<img src={useBaseUrl("img/wxm-devices/m5/u-bracket-installation.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/u-bracket-installation.svg")} />
</div>

#### U-bracket installation
Expand Down
2 changes: 1 addition & 1 deletion docs/wxm-devices/m5/contents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The outdoor sensor is responsible for:
1. the wireless transmission of the data to the weather miner.

<div class="explanation two-columns">
<img src={useBaseUrl("img/wxm-devices/m5/ws1000-parts.svg")} />
<img src={useBaseUrl("img/wxm-devices/ws1000/parts.svg")} />
<div>
<h4>Components</h4>
<ol>
Expand Down
Loading