PSBuienradar

0.0.1

en-US/PSBuienradar/PSBuienradar-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh">

  <command:command>

    <command:details>

      <command:name>Get-WeatherSurvivalAdvice</command:name>

      <maml:description>

        <maml:para>Returns a humorous Dutch weather survival report for your current location</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>WeatherSurvivalAdvice</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Orchestrates the full BuienRadar weather survival pipeline:     1. Detects the user's public IP address     2. Resolves the IP to geographic coordinates and city name     3. Fetches the two-hour rain forecast from BuienRadar     4. Downloads the BuienRadar weather feed and finds the nearest station     5. Assembles a custom PSCustomObject with weather data and survival advice</maml:para>

      <maml:para>Survival advice is generated based on current conditions:     - Heavy rain    -&gt; urgent evacuation humour     - Moderate rain -&gt; umbrella reminders     - Light rain    -&gt; mild caution     - No rain       -&gt; cautiously optimistic encouragement</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-WeatherSurvivalAdvice</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <dev:name>PSCustomObject</dev:name>

        </dev:type>

        <maml:description>

          <maml:para>{{ Fill in the Description }}</maml:para>

        </maml:description>

      </command:returnValue>

      <command:returnValue>

        <dev:type>

          <dev:name>System.Management.Automation.PSObject</dev:name>

        </dev:type>

        <maml:description>

          <maml:para>{{ Fill in the Description }}</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>Requires internet access to the following endpoints:

    - https://api.ipify.org

    - http://ip-api.com

    - https://gpsgadget.buienradar.nl

    - https://data.buienradar.nl</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- EXAMPLE 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Get-WeatherSurvivalAdvice</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Detects location automatically and returns the survival report.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

      <command:example>

        <maml:title>--------- EXAMPLE 2 ---------</maml:title>

        <maml:introduction>

          <maml:para>$report = Get-WeatherSurvivalAdvice

$report.SurvivalAdvice</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Retrieves only the survival advice text.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <command:uri />

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>Description }}</maml:para>

        </maml:description>

      </command:returnValue>

      <command:returnValue>

        <dev:type>

          <dev:name>System.Management.Automation.PSObject</dev:name>

        </dev:type>

        <maml:description>

          <maml:para>{{ Fill in the Description }}</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>Uses https://gpsgadget.buienradar.nl/data/raintext?lat={lat}&amp;lon={lon}.

Data is updated approximately every 5 minutes.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- EXAMPLE 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Get-RainForecast -Latitude 52.37 -Longitude 4.90</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Returns the next two-hour rain forecast for Amsterdam.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <command:uri />

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- EXAMPLE 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>$feed = Invoke-RestMethod -Uri 'https://data.buienradar.nl/2.0/feed/json'

Get-NearestWeatherStation -Latitude 52.37 -Longitude 4.90 -Stations $feed.actual.stationmeasurements</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Returns the weather station closest to Amsterdam.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <command:uri />

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>