pstools.daikin

1.10

en-US/pstools.daikin-help.xml

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

<helpItems schema="maml" xmlns="http://msh">

  <command:command 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

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

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

      <command:noun>DaikinStatus</command:noun>

      <maml:description>

        <maml:para></maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Retreives the current configuration of the Daikin AirCon device</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

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

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>HostName</maml:name>

          <maml:description>

            <maml:para>Hostname or IP of the Daikin Aircon device.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>HostName</maml:name>

        <maml:description>

          <maml:para>Hostname or IP of the Daikin Aircon device.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

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

        <dev:code>Get-DaikinStatus -Hostname daikin.local.network</dev:code>

        <dev:remarks>

          <maml:para>PowerOn        : True Mode           : HEAT TargetTemp     : 22.0 ...</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Set-DaikinAirCon</command:name>

      <command:verb>Set</command:verb>

      <command:noun>DaikinAirCon</command:noun>

      <maml:description>

        <maml:para></maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Cmdlet allows to configure the aircon device to the desired setting.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-DaikinAirCon</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>HostName</maml:name>

          <maml:description>

            <maml:para>Hostname or IP of the Daikin AirCon device.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>PowerOn</maml:name>

          <maml:description>

            <maml:para>Set to $true or $false to specify if the master power should be on or off. This does not the affect the connectivity of the control surfice.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>

          <dev:type>

            <maml:name>Boolean</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

          <maml:name>Temp</maml:name>

          <maml:description>

            <maml:para>Specified the target temperature in celcius.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>0</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

          <maml:name>Mode</maml:name>

          <maml:description>

            <maml:para>Specifies the operating mode of the aircon device. Allowed values are; AUTO  : Switches between heat and cold depending on the current and target temperature. DRY   : Sets the device lower the humidity of the air. COLD  : Sets the device chill the air if needed. No heat will be provided. HEAT  : Sets the device heat the air if needed. No chilling of air will be provided. FAN   : Sets the device to only circulate air without affecting temperature or humidity.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

          <maml:name>FanSpeed</maml:name>

          <maml:description>

            <maml:para>Specifies the strenght of the fan. Allowed values are; AUTO   : Sets the device to manage fan speed to keep the target climate. SILENT : Sets the fan speed to minimize noise. Level_1 -&gt; Level_5 : Sets the fan speed to the target level.</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none">

          <maml:name>FanDirection</maml:name>

          <maml:description>

            <maml:para>Specifies how the direction of airflow is controlled. Allowed values are Stopped, VerticalSwing, HorizontalSwing and BothSwing</maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>HostName</maml:name>

        <maml:description>

          <maml:para>Hostname or IP of the Daikin AirCon device.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

        <maml:name>PowerOn</maml:name>

        <maml:description>

          <maml:para>Set to $true or $false to specify if the master power should be on or off. This does not the affect the connectivity of the control surfice.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>

        <dev:type>

          <maml:name>Boolean</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

        <maml:name>Temp</maml:name>

        <maml:description>

          <maml:para>Specified the target temperature in celcius.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>0</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none">

        <maml:name>Mode</maml:name>

        <maml:description>

          <maml:para>Specifies the operating mode of the aircon device. Allowed values are; AUTO  : Switches between heat and cold depending on the current and target temperature. DRY   : Sets the device lower the humidity of the air. COLD  : Sets the device chill the air if needed. No heat will be provided. HEAT  : Sets the device heat the air if needed. No chilling of air will be provided. FAN   : Sets the device to only circulate air without affecting temperature or humidity.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none">

        <maml:name>FanSpeed</maml:name>

        <maml:description>

          <maml:para>Specifies the strenght of the fan. Allowed values are; AUTO   : Sets the device to manage fan speed to keep the target climate. SILENT : Sets the fan speed to minimize noise. Level_1 -&gt; Level_5 : Sets the fan speed to the target level.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none">

        <maml:name>FanDirection</maml:name>

        <maml:description>

          <maml:para>Specifies how the direction of airflow is controlled. Allowed values are Stopped, VerticalSwing, HorizontalSwing and BothSwing</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

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

        <dev:code>Set-DaikinAirCon -HostName daikin.local.network -PowerOn:$true -Temp 19 -Mode AUTO -FanSpeed AUTO -FanDirection Stopped</dev:code>

        <dev:remarks>

          <maml:para>This example configures the aircon device to the specified parameter values.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>