Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
@jllcunha
jllcunha authored May 26, 2018
1 parent 137c505 commit 2316659
Show file tree
Hide file tree
Showing 4 changed files with 173 additions and 0 deletions.
115 changes: 115 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# GreeAir Binding

This binding allows you too add Gree Air Conditioners as things. Once added as a thing, the user can control the Air Conditioner, similarly to how the Air Conditioner is controlled using the remote control or smartphone app.

Note: The Gree Air Conditioner must already be setup on the wifi network and must have a fixed IP Address.

## Supported Things

This binding supports one Thing type: `greeair`.

## Discovery

Discovery is possible but as yet is not supported in this binding.

## Binding Configuration

No binding configuration required.

#### Manual Thing Creation

Fans can be manually created in the *PaperUI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory. See example below.


## Thing Configuration

The Air Conditioners IP address and refresh rate (in seconds) and network broadcast address are set at time of discovery. However, in the event that any of this information changes, the Air Conditioners configuration must be updated.

## Channels

The following channels are supported for fans:

| Channel Name | Item Type | Description |
|-------------------------|--------------|-------------------------------------------------------|
| power-channel | Switch | Power on/off the Air Conditioner |
| mode-channel | Number | Sets the operating mode of the Air Conditioner |
| | Mode: Auto: 0, Cool: 1, Dry: 2, Fan: 3, Heat: 4 |
| | For more details see the Air Conditioner's operating |
| | manual. |
| turbo-channel | Switch | Set on/off the Air Conditioner's Turbo mode. |
| | For more details see the Air Conditioner's operating |
| | manual. |
| light-channel | Switch | Enable/disable the front display on the Air |
| | Conditioner if applicable to the Air Conditioner model|
| temp-channel | Number | Sets the desired room temperature |
| swingvertical-channel | Number | Sets the vertical swing action on the Air Conditioner |
| | Full Swing: 1, Up: 2, MidUp: 3, Mid: 4, Mid Down: 5, |
| | Down : 6 |
| windspeed-channel | Number | Sets the fan speed on the Air conditioner |
| | Auto:0, Low:1, MidLow:2, Mid:3, MidHigh:4, High:5 |
| | The number of speeds depends on the Air Conditioner |
| | model. |
| air-channel | Switch | Set on/off the Air Conditioner's Air function if |
| | applicable to the Air Conditioner model |
| dry-channel | Switch | Set on/off the Air Conditioner's Dry function if |
| | applicable to the Air Conditioner model |
| health-channel | Switch | Set on/off the Air Conditioner's Health function if |
| | applicable to the Air Conditioner model |
| pwrsav-channel | Switch | Set on/off the Air Conditioner's Power Saving function| |
| | if applicable to the Air Conditioner model |


## Full Example

Things:

```
Thing greeair:greeairthing:b2d08bb1 [ ipAddress="192.168.12.62", refresh=2 ]
```

Items:

```
Switch AirconPower { channel="greeair:greeairthing:b2d08bb1:powerchannel" }
Number AirconMode { channel="greeair:greeairthing:b2d08bb1:modechannel" }
Switch AirconTurbo { channel="greeair:greeairthing:b2d08bb1:turbochannel" }
Switch AirconLight { channel="greeair:greeairthing:b2d08bb1:lightchannel" }
Number AirconTemp "Temperature [%.1f °C]" {channel="greeair:greeairthing:b2d08bb1:tempchannel" }
Number AirconTempSet { channel="greeair:greeairthing:b2d08bb1:tempchannel" }
Number AirconSwingVertical { channel="greeair:greeairthing:b2d08bb1:swingverticalchannel" }
Number AirconFanSpeed { channel="greeair:greeairthing:b2d08bb1:windspeedchannel" }
Switch AirconAir { channel="greeair:greeairthing:b2d08bb1:airchannel" }
Switch AirconDry { channel="greeair:greeairthing:b2d08bb1:drychannel" }
Switch AirconHealth { channel="greeair:greeairthing:b2d08bb1:healthchannel" }
Switch AirconPowerSaving { channel="greeair:greeairthing:b2d08bb1:pwrsavchannel" }
```

Sitemap:

This is an example of how to set up your sitemap.

```
Frame label="Controls"
{
Switch item=AirconPower label="Power" icon=switch
Switch item=AirconMode label="Mode" mappings=[0="Auto", 1="Cool", 2="Dry", 3="Fan", 4="Heat"]
Setpoint item=AirconTemp label="Set temperature" icon=temperature minValue=16 maxValue=30 step=1
}
Frame label="Fan Speed"
{
Switch item=AirconFanSpeed label="Fan Speed" mappings=[0="Auto", 1="Low", 2="Medium Low", 3="Medium", 4="Medium High", 5="High"] icon=fan
}
Frame label="Fan-Swing Direction"
{
Switch item=AirconSwingVertical label="Direction" mappings=[0="Off", 1="Full", 2="Up", 3="Mid-up", 4="Mid", 5="Mid-low", 6="Down"] icon=flow
}
Frame label="Options"
{
Switch item=AirconTurbo label="Turbo" icon=fan
Switch item=AirconLight label="Light" icon=light
Switch item=AirconAir label="Air" icon=flow
Switch item=AirconDry label="Dry" icon=rain
Switch item=AirconHealth label="Health" icon=smiley
Switch item=AirconPowerSaving label="Power Saving" icon=poweroutlet
}
```
33 changes: 33 additions & 0 deletions about.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<title>About</title>
</head>
<body lang="EN-US">
<h2>About This Content</h2>

<p>March 30, 2017</p>
<h3>License</h3>

<p>
The openHAB community makes available all content in this plug-in (&quot;Content&quot;). Unless otherwise
indicated below, the Content is provided to you under the terms and conditions of the
Eclipse Public License Version 1.0 (&quot;EPL&quot;). A copy of the EPL is available
at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
For purposes of the EPL, &quot;Program&quot; will mean the Content.
</p>

<p>
If you did not receive this Content directly from the openHAB community, the Content is
being redistributed by another party (&quot;Redistributor&quot;) and different terms and conditions may
apply to your use of any object code in the Content. Check the Redistributor's license that was
provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise
indicated below, the terms and conditions of the EPL still apply to any source code in the Content
and such source code may be obtained at <a href="http://www.openhab.org/">openhab.org</a>.
</p>

</body>
</html>

8 changes: 8 additions & 0 deletions build.properties
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
source..=src/main/java/
output..=target/classes
bin.includes=META-INF/,\
.,\
OSGI-INF/,\
ESH-INF/,\
about.html

17 changes: 17 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<artifactId>pom</artifactId>
<groupId>org.openhab.binding</groupId>
<version>2.3.0-SNAPSHOT</version>
</parent>

<artifactId>org.openhab.binding.greeair</artifactId>
<packaging>eclipse-plugin</packaging>

<name>GreeAir Binding</name>

</project>

0 comments on commit 2316659

Please sign in to comment.