Updated external content (Jenkins build 162)
openHAB Build Server
parent
a668dff38b
commit
e4f40dc228
File diff suppressed because one or more lines are too long
|
|
@ -122,7 +122,6 @@ The following configuration parameters are available on the Ecobee Account:
|
|||
| refreshIntervalQuick | Integer | Required | Specifies the interval in seconds with which the Ecobee data will be updated after sending an update or executing a function. |
|
||||
| apiTimeout | Integer | Required | Time in seconds to allow an API request against the Ecobee servers to complete. |
|
||||
| discoveryEnabled | Switch | Required | Specifies whether the binding should auto-discover thermostats and remote sensors. |
|
||||
| discoveryInterval | Integer | Optional | Specifies time interval in seconds in which the binding will attempt to discover thermostats. |
|
||||
|
||||
### Ecobee Thermostat
|
||||
|
||||
|
|
|
|||
|
|
@ -33,14 +33,19 @@ It can be extended with different channels.
|
|||
| `delay` | no | 0 | Delay between two requests in ms (advanced parameter). |
|
||||
| `username` | yes | - | Username for authentication (advanced parameter). |
|
||||
| `password` | yes | - | Password for authentication (advanced parameter). |
|
||||
| `authMode` | no | BASIC | Authentication mode, `BASIC` or `DIGEST` (advanced parameter). |
|
||||
| `authMode` | no | BASIC | Authentication mode, `BASIC`, `BASIC_PREEMPTIVE` or `DIGEST` (advanced parameter). |
|
||||
| `commandMethod` | no | GET | Method used for sending commands `GET`, `PUT`, `POST`. |
|
||||
| `contentType` | yes | - | MIME content-type of the command requests. Only used for `PUT` and `POST`. |
|
||||
| `encoding` | yes | - | Encoding to be used if no encoding is found in responses (advanced parameter). |
|
||||
| `headers` | yes | - | Additional headers that are sent along with the request. Format is "header=value".|
|
||||
| `ignoreSSLErrors` | no | false | If set to true ignores invalid SSL certificate errors. This is potentially dangerous.|
|
||||
|
||||
*Note:* optional "no" means that you have to configure a value unless a default is provided and you are ok with that setting.
|
||||
*Note:* Optional "no" means that you have to configure a value unless a default is provided and you are ok with that setting.
|
||||
|
||||
*Note:* The `BASIC_PREEMPTIVE` mode adds basic authentication headers even if the server did not request authentication.
|
||||
This is dangerous and might be misused.
|
||||
The option exists to be able to authenticate when the server is not sending the proper 401/Unauthorized code.
|
||||
Authentication might fail if redirections are involved as headers are stripper prior to redirection.
|
||||
|
||||
*Note:* If you rate-limit requests by using the `delay` parameter you have to make sure that the time between two refreshes is larger than the time needed for one refresh cycle.
|
||||
|
||||
|
|
@ -57,11 +62,11 @@ The `image` channel-type supports `stateExtension` only.
|
|||
| `commandExtension` | yes | - | Appended to the `baseURL` for sending commands. If empty, same as `stateExtension`. |
|
||||
| `stateTransformation ` | yes | - | One or more transformation applied to received values before updating channel. |
|
||||
| `commandTransformation` | yes | - | One or more transformation applied to channel value before sending to a remote. |
|
||||
| `mode` | no | `READWRITE` | Mode this channel is allowed to operate. `READ` means receive state, `WRITE` means send commands. |
|
||||
| `mode` | no | `READWRITE` | Mode this channel is allowed to operate. `READONLY` means receive state, `WRITEONLY` means send commands. |
|
||||
|
||||
Transformations need to be specified in the same format as
|
||||
Some channels have additional parameters.
|
||||
When concatenating the `baseURL` and `stateExtions` or `commandExtension` the binding checks if a proper URL part separator (`/`, `&` or `?`) is present and adds a `/` if missing.
|
||||
When concatenating the `baseURL` and `stateExtension` or `commandExtension` the binding checks if a proper URL part separator (`/`, `&` or `?`) is present and adds a `/` if missing.
|
||||
|
||||
### Value Transformations (`stateTransformation`, `commandTransformation`)
|
||||
|
||||
|
|
@ -162,4 +167,4 @@ is transformed to
|
|||
|
||||
```
|
||||
http://www.domain.org/home/lights/23871/?status=OFF&date=2020-07-06
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -311,15 +311,15 @@ Number:Dimensionless KWL_Stage_Percent "KWL fan stage [%d %unit%]"
|
|||
|
||||
// Party mode
|
||||
Switch KWL_Party_Mode "Party mode" <parents> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#partyModeStatus"}
|
||||
Number KWL_Party_Mode_Duration "Party mode duration" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#partyModeDuration"}
|
||||
Number:Time KWL_Party_Mode_Duration "Party mode duration [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#partyModeDuration"}
|
||||
Number KWL_Party_Mode_Stage "Party mode fan stage" <fan> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#partyModeFanStage"}
|
||||
Number KWL_Party_Mode_Remaining "Party mode remaining time [%d min]" <clock> (gKWL) {channel="modbus:helios-ventilation-easycontrols:modbus-gateway:kwl:operation#partyModeRemainingTime"}
|
||||
Number:Time KWL_Party_Mode_Remaining "Party mode remaining time [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-ventilation-easycontrols:modbus-gateway:kwl:operation#partyModeRemainingTime"}
|
||||
|
||||
// Standby mode
|
||||
Switch KWL_Standby_Mode "Standby mode" <fan_off> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeStatus"}
|
||||
Number KWL_Standby_Mode_Duration "Standby mode duration" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeDuration"}
|
||||
Number:Time KWL_Standby_Mode_Duration "Standby mode duration [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeDuration"}
|
||||
Number KWL_Standby_Mode_Stage "Standby mode fan stage" <fan> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeFanStage"}
|
||||
Number KWL_Standby_Mode_Remaining "Standby mode remaining time [%d min]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeRemainingTime"}
|
||||
Number:Time KWL_Standby_Mode_Remaining "Standby mode remaining time [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:operation#standbyModeRemainingTime"}
|
||||
|
||||
// Status infos
|
||||
Number:Temperature KWL_Temp_Outide_Air "Temperature outside air [%.1f °C]" <temperature> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#temperatureOutsideAir"}
|
||||
|
|
@ -329,7 +329,7 @@ Number:Temperature KWL_Temp_Extract_Air "Temperature extract air [%.1f °C]"
|
|||
Number KWL_Supply_Air_RPM "RPM supply air [%d]" <fan> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#supplyAirRpm"}
|
||||
Number KWL_Extract_Air_RPM "RPM extract air [%d]" <fan> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#extractAirRpm"}
|
||||
Number KWL_Filter_Change "Filter change [MAP(helios_yes_no.map):%s]" <none> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:unitConfig#filterChange"}
|
||||
Number KWL_Filter_Change_Remaining "Filter change [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#filterChangeRemainingTime"}
|
||||
Number:Time KWL_Filter_Change_Remaining "Filter change [%d %unit%]" <clock> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#filterChangeRemainingTime"}
|
||||
|
||||
Number KWL_Errors "Number errors [%d]" <error> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#noOfErrors"}
|
||||
String KWL_Errors_String "Error messages [%s]" <error> (gKWL) {channel="modbus:helios-easycontrols:modbus-gateway:kwl:general#errorsMsg"}
|
||||
|
|
|
|||
|
|
@ -49,7 +49,8 @@ Configuration of serialAvr:
|
|||
Example:
|
||||
|
||||
```
|
||||
pioneeravr:ipAvr:vsx921IP [ address="192.168.1.25", tcpPort="23" ]
|
||||
pioneeravr:ipAvr:vsx921IP [ address="192.168.1.25" ]
|
||||
pioneeravr:ipAvr:vsx921IP [ address="192.168.1.25", tcpPort=32 ]
|
||||
pioneeravr:serialAvr:vsx921Serial [ serialPort="COM9" ]
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -173,9 +173,9 @@ The API must be enabled in the ZoneMinder configuration using the **OPT_USE_API*
|
|||
```
|
||||
Bridge zoneminder:server:server [ host="192.168.1.100", refreshInterval=5, defaultAlarmDuration=120, discoveryEnabled=true, useDefaultUrlPath=true ]
|
||||
|
||||
Thing zoneminder:monitor:1 "Monitor 1" (zm:server:server) [ monitorId="1", imageRefreshInterval=10, alarmDuration=180 ]
|
||||
Thing zoneminder:monitor:1 "Monitor 1" (zoneminder:server:server) [ monitorId="1", imageRefreshInterval=10, alarmDuration=180 ]
|
||||
|
||||
Thing zoneminder:monitor:2 "Monitor 2" (zm:server:server) [ monitorId="2", imageRefreshInterval=10, alarmDuration=180 ]
|
||||
Thing zoneminder:monitor:2 "Monitor 2" (zoneminder:server:server) [ monitorId="2", imageRefreshInterval=10, alarmDuration=180 ]
|
||||
```
|
||||
|
||||
### Items
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ The skill connects your openHAB setup through the [myopenHAB.org](http://myopenH
|
|||
|
||||
## Requirements
|
||||
|
||||
* [openHAB Cloud Connector](http://docs.openhab.org/addons/ios/openhabcloud/readme.html) configured using myopenHAB.org
|
||||
* [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/) configured using myopenHAB.org
|
||||
* Amazon account
|
||||
* Amazon Echo, Amazon Echo Dot or compatible Alexa device
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Before you can integrate this service with your Google Cloud Text-to-Speech, you
|
|||
* Set up authentication:
|
||||
* Go to the "APIs & Services" -> "Credentials" page in the GCP Console and your project. [link](https://console.cloud.google.com/apis/credentials)
|
||||
* From the "Create credentials" drop-down list, select "OAuth client ID.
|
||||
* Select application type "Other" and enter a name into the "Name" field.
|
||||
* Select application type "TV and Limited Input" and enter a name into the "Name" field.
|
||||
* Click Create. A pop-up appears, showing your "client ID" and "client secret".
|
||||
|
||||
## Service Configuration
|
||||
|
|
|
|||
|
|
@ -200,14 +200,14 @@
|
|||
<item-type>Number:Time</item-type>
|
||||
<label>Current Time</label>
|
||||
<description>Current time of currently playing media</description>
|
||||
<state readOnly="true" pattern="%d %unit%"/>
|
||||
<state readOnly="true" pattern="%.0f %unit%"/>
|
||||
</channel-type>
|
||||
|
||||
<channel-type id="duration" advanced="true">
|
||||
<item-type>Number:Time</item-type>
|
||||
<label>Duration</label>
|
||||
<description>Length of currently playing media</description>
|
||||
<state readOnly="true" pattern="%d %unit%"/>
|
||||
<state readOnly="true" pattern="%.0f %unit%"/>
|
||||
</channel-type>
|
||||
|
||||
<!-- Metadata Information -->
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@
|
|||
<label>Authentication Mode</label>
|
||||
<options>
|
||||
<option value="BASIC">Basic Authentication</option>
|
||||
<option value="BASIC_PREEMPTIVE">Preemptive Basic Authentication</option>
|
||||
<option value="DIGEST">Digest Authentication</option>
|
||||
</options>
|
||||
<default>BASIC</default>
|
||||
|
|
|
|||
|
|
@ -463,19 +463,19 @@
|
|||
<item-type>Number:Time</item-type>
|
||||
<label>Current Time</label>
|
||||
<description>Current time of currently playing media</description>
|
||||
<state pattern="%d %unit%"/>
|
||||
<state pattern="%.0f %unit%"/>
|
||||
</channel-type>
|
||||
<channel-type id="currenttimepercentage" advanced="true">
|
||||
<item-type>Number:Dimensionless</item-type>
|
||||
<label>Current Time in Percent</label>
|
||||
<description>Current time of currently playing media</description>
|
||||
<state readOnly="true" min="0" max="100" pattern="%d %unit%"/>
|
||||
<state readOnly="true" pattern="%.0f %unit%"/>
|
||||
</channel-type>
|
||||
<channel-type id="duration">
|
||||
<item-type>Number:Time</item-type>
|
||||
<label>Duration</label>
|
||||
<description>Length of currently playing media</description>
|
||||
<state readOnly="true" pattern="%d %unit%"/>
|
||||
<state readOnly="true" pattern="%.0f %unit%"/>
|
||||
</channel-type>
|
||||
<channel-type id="id" advanced="true">
|
||||
<item-type>Number</item-type>
|
||||
|
|
|
|||
|
|
@ -73,6 +73,9 @@
|
|||
<channel id="eventAlarmFrames" typeId="eventAlarmFrames"/>
|
||||
<channel id="eventLength" typeId="eventLength"/>
|
||||
</channels>
|
||||
|
||||
<representation-property>monitorId</representation-property>
|
||||
|
||||
<config-description-ref uri="thing-type:zoneminder:monitor"/>
|
||||
</thing-type>
|
||||
|
||||
|
|
|
|||
|
|
@ -104,10 +104,10 @@ then
|
|||
logInfo("alarm", "Scheduling alarm for {} ({})", newState.toLocaleZone, epoch)
|
||||
if (timerAlarm !== null) {
|
||||
logInfo("alarm", "Reschedule alarm")
|
||||
timerAlarm.reschedule(new DateTime(epoch))
|
||||
timerAlarm.reschedule(newState.toLocaleZone.zonedDateTime)
|
||||
} else {
|
||||
logInfo("alarm", "New alarm")
|
||||
timerAlarm = createTimer(new DateTime(epoch), [ |
|
||||
timerAlarm = createTimer(newState.toLocaleZone.zonedDateTime, [ |
|
||||
// Turn on stuff, e.g. radio or light
|
||||
logInfo("alarm", "Alarm expired")
|
||||
timerAlarm = null
|
||||
|
|
|
|||
|
|
@ -6,7 +6,11 @@ source: https://github.com/openhab/openhabian/blob/master/docs/openhabian.md
|
|||
|
||||
{% include base.html %}
|
||||
|
||||
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
|
||||
<!-- Attention authors: Do not edit directly. Please add your changes to the source repository -->
|
||||
|
||||
::: tip TL;DR
|
||||
Jump to [install instructions](#Raspberry-Pi-prepackaged-SD-card-image).
|
||||
:::
|
||||
|
||||
# openHABian - Hassle-free openHAB Setup
|
||||
The Raspberry Pi and other small single-board computers are quite famous platforms for openHAB.
|
||||
|
|
@ -27,7 +31,7 @@ To that end, the project provides two things:
|
|||
{:toc}
|
||||
|
||||
## Features
|
||||
The following features are provided by the openHABian image out of the box:
|
||||
Out of the box, the openHABian image provides
|
||||
|
||||
- Hassle-free setup without a display or keyboard, connected via Ethernet or [WiFi](#wifi-based-setup-notes)
|
||||
- the latest stable version of openHAB
|
||||
|
|
@ -48,9 +52,9 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian
|
|||
|
||||
|
||||
- Switch openHAB versions 2 vs 3 and select the latest *Release*, *Milestone* or *Snapshot* [*unstable/SNAPSHOT* build](https://www.openhab.org/docs/installation/linux.html#changing-versions) version
|
||||
- Install and Setup a [reverse proxy](security.html#nginx-reverse-proxy) with password authentication and/or HTTPS access (incl. [Let's Encrypt](https://letsencrypt.org) certificate) for self-controlled remote access
|
||||
- Install and Setup a [reverse proxy](security.html##running-openhab-behind-a-reverse-proxy) with password authentication and/or HTTPS access (incl. [Let's Encrypt](https://letsencrypt.org) certificate) for self-controlled remote access
|
||||
- manually set up a WiFi connection
|
||||
- Setup [Backup](#backup) for your system
|
||||
- Setup [Backup](#availability-and-backup) for your system
|
||||
- Easily install and preconfigure [Optional Components](#optional-components) of your choice
|
||||
- configure Raspberry Pi specific functions
|
||||
- Prepare the serial port for the use with extension boards like RaZberry, Enocean Pi, ...
|
||||
|
|
@ -58,15 +62,88 @@ The included **openHABian Configuration Tool** [`openhabian-config`](#openhabian
|
|||
- Move the system partition to an external USB stick or drive
|
||||
... and much more
|
||||
|
||||
## Quick Start
|
||||
## Hardware
|
||||
|
||||
### Hardware recommendation
|
||||
Let's put this first: our current recommendation is to get a RPi 4 with 2 or 4 GB,
|
||||
a 3 A power supply and a 16 GB SD card.
|
||||
Also get another 32 GB or larger SD card and a USB card reader to make use of the
|
||||
["auto backup" feature](docs/openhabian.md#Auto-Backup).
|
||||
***
|
||||
FIRST, check the [README](https://github.com/openhab/openhabian/blob/master/README.md) if your hardware and OS are supported
|
||||
ATTENTION:<br>
|
||||
Avoid getting the 8 GB model of RPi 4. 8 GB are a waste of money and it has issues,
|
||||
you must [disable ZRAM](https://github.com/openhab/openhabian/blob/master/docs/openhabian.md#disable-zram) or use the 64bit image (untested).
|
||||
***
|
||||
### Hardware and OS support
|
||||
As of openHABian version 1.6 and later, all Raspberry Pi models are supported as
|
||||
hardware. Anything x86 based may work or not. Anything else ARM based such as ODroids,
|
||||
OrangePis and the like may work or not. NAS servers such as QNAP and Synology
|
||||
boxes will not work. Support for PINEA64 was dropped in this current release.<br>
|
||||
We strongly recommend that users choose Raspberry Pi 2, 3 or 4 systems to have
|
||||
1 GB of RAM or more. RPi 1 and 0/0W only have a single CPU core and 512 MB.
|
||||
This can be sufficient to run a smallish openHAB setup, but it will
|
||||
not be enough to run a full-blown system with many bindings and memory consuming
|
||||
openHABian features/components such as ZRAM, InfluxDB or Grafana.
|
||||
We do not actively prohibit installation on any hardware, including unsupported
|
||||
systems, but we might skip or deny to install specific extensions such as those
|
||||
memory hungry applications named above.
|
||||
|
||||
### Raspberry Pi (Prepackaged SD Card Image)
|
||||
Supporting hardware means testing every single patch and every release. There
|
||||
are simply too many combinations of SBCs, peripherals and OS flavors that
|
||||
maintainers do not have available, or, even if they did, the time to spend on
|
||||
the testing efforts that is required to make openHABian a reliable system.
|
||||
Let's make sure you understand the implications of these statements: it means
|
||||
that to run on hardware other than RPi 2/3/4 or (bare metal i.e. not virtualized)
|
||||
x86 may work but this is **not** supported.
|
||||
|
||||
It may work to install and run openHABian on unsupported hardware. If it does
|
||||
not work, you are welcome to find out what's missing and contribute it back to
|
||||
the community with a Pull Request. It is sometimes simple things like a naming
|
||||
string. We'll be happy to include that in openHABian so you can use your box
|
||||
with openHABian unless there's a valid reason to change or remove it.
|
||||
However, that does not make your box a "supported" one as we don't have it
|
||||
available for our further development and testing. So there remains a risk that
|
||||
future openHABian releases will fail to work on your SBC because we changed a
|
||||
thing that broke support for your HW - unintentionally so however inevitable.
|
||||
|
||||
For ARM hardware that we don't support, you can try any of the [fake hardware parameters](openhabian.md/#fake-hardware-mode)
|
||||
to 'simulate' RPi hardware and Raspi OS. If that still doesn't work for
|
||||
you, give [Ubuntu](https://ubuntu.com/download/iot) or [ARMbian](https://www.armbian.com/) a try.
|
||||
|
||||
Going beyond what the RPi image provides, as a manually installed set of
|
||||
scripts, we support running openHABian on x86 hardware on generic Debian.
|
||||
On ARM, we only support Raspberry Pi OS.
|
||||
These are what we develop and test openHABian against.
|
||||
We do **not** actively **support Ubuntu** so no promises but we provide code
|
||||
"as-is" that is known to run on there. Several optional components though,
|
||||
such as WireGuard or Homegear, are known to expose problems.
|
||||
|
||||
We expect you to use the current stable distribution, 'buster' for Raspberry
|
||||
Pi OS (ARM) and Debian (x86) and 'focal' for Ubuntu (x86) this is.
|
||||
To install openHABian on anything older or newer may work or not. If you
|
||||
encounter issues, you may need to upgrade first or to live with the consequences
|
||||
of running an OS on the edge of software development.
|
||||
|
||||
Either way, please note that you're on your own when it comes to configuring and
|
||||
installing the HW with the proper OS yourself.
|
||||
|
||||
### 64 bit ?
|
||||
RPi3 and 4 have a 64 bit processor and you may want to run openHAB in 64 bit.
|
||||
We provide a 64bit version of the image but it is unsupported so use it at your
|
||||
own risk. Please don't ask for support if it does not work for you.
|
||||
It's just provided as-is.
|
||||
Be aware that to run in 64 bit has a major drawback: increased memory usage.
|
||||
That is not a good idea on a heavily memory constrained platform like a RPi.
|
||||
Also remember openHABian makes use of Raspberry Pi OS which as per today still
|
||||
is a 32 bit OS.
|
||||
We are closely observing development and will adapt openHABian once it will
|
||||
reliably work on 64 bit.<br/>
|
||||
|
||||
On x86 hardware, 64 bit is the standard.
|
||||
|
||||
## Raspberry Pi prepackaged SD card image
|
||||
**Flash, plug, wait, enjoy:**
|
||||
The provided image is based on the [Raspberry Pi OS Lite](https://www.raspberrypi.org/downloads/raspberry-pi-os/) (previously called Raspbian) standard system.
|
||||
The provided image is based on the [Raspberry Pi OS Lite](https://www.raspberrypi.org/software/operating-systems/#raspberry-pi-os-32-bit) (previously called Raspbian) standard system.
|
||||
On first boot, the system will set up openHAB and the mentioned settings and tools.
|
||||
All packages will be downloaded in their newest version and configured to work without further modifications.
|
||||
The whole process will take a few minutes, then openHAB and all other needed tools to get started will be ready to use without further configuration steps.
|
||||
|
|
@ -75,7 +152,7 @@ openHABian is designed as a headless system, you will not need a display or a ke
|
|||
**Setup:**
|
||||
|
||||
- [Download the latest "openHABian" SD card image file](https://github.com/openhab/openhabian/releases) (Note: the file is *xz* compressed)
|
||||
- Write the image to your SD card (e.g. with [Etcher](https://www.balena.io/etcher/), able to directly work with *xz* files)
|
||||
- Write the image to your SD card (e.g. with [Etcher](https://www.balena.io/etcher/) or official [Raspberry Pi Imager](https://www.raspberrypi.org/software/), both able to directly work with *xz* files
|
||||
- Insert the SD card into your Raspberry Pi, connect Ethernet ([WiFi also supported](#wifi-based-setup-notes)) and power on.
|
||||
- Wait approximately **15-45 minutes** for openHABian to do its magic. <br>(You can check the progress in your web-browser [here](http://openhabiandevice).)
|
||||
- Enjoy!
|
||||
|
|
@ -286,9 +363,9 @@ ZRAM is activated by default on fresh installations on ARM hardware except on a
|
|||
If you want to disable ZRAM for a different reason, use `zraminstall=disable` in `openhabian.conf` to install without.
|
||||
|
||||
#### Debug mode
|
||||
See [Troubleshooting](#Troubleshooting) section if you run into trouble installing. If you want to turn on debug mode,
|
||||
See [Troubleshooting](#troubleshooting) section if you run into trouble installing. If you want to turn on debug mode,
|
||||
edit `openhabian.conf` and set the `debugmode=` parameter to either `off`, `on` or `maximum`.
|
||||
Mind you that if you intend to open an issue, we need you to provide the output of `debugmode=maximum`.
|
||||
Mind you that if you intend to open an issue, we need you to provide the output of `debugmode=maximum` so if you're in interactive mode, set your terminal to record output.
|
||||
|
||||
#### Auto-backup
|
||||
You might want to setup openHABian to automatically backup and mirror your internal SD card to an external unit.
|
||||
|
|
@ -354,7 +431,7 @@ You'll find all of these in the [openHABian Configuration Tool](#openhabian-conf
|
|||
- Tellstick core
|
||||
|
||||
## Troubleshooting
|
||||
If you're having problems to get openHABian to install properly, check out the [debug guide](https://github.com/openhab/openhabian/blob/master/docs/openhabian-DEBUG.md). It's also available on your system as [/opt/openhabian/docs/openhabian-DEBUG.md](openhabian-DEBUG.md).
|
||||
If you're having problems to get openHABian to install properly, check out the [debug guide](openhabian-DEBUG.md). It's also available on your system as `/opt/openhabian/docs/openhabian-DEBUG.md`.
|
||||
Do not hesitate to ask for help on the [openHABian community forum](https://community.openhab.org/) when the debug guide doesn't help.
|
||||
Remember to [mind the rules](https://community.openhab.org/t/how-to-ask-a-good-question-help-us-help-you/58396) please.
|
||||
|
||||
|
|
@ -365,7 +442,7 @@ If you want to get involved, you found a bug, or just want to see what's planned
|
|||
<a id="changelog"></a>
|
||||
### Where can I find a changelog for openHABian?
|
||||
Official announcements are co-located with the download links [here](https://github.com/openhab/openhabian/releases).
|
||||
If you want to stay in touch with all the latest code changes under the hood, see the [commit history](https://github.com/openhab/openhabian/commits/master) for openHABian.
|
||||
If you want to stay in touch with all the latest code changes under the hood, see [commit history](https://github.com/openhab/openhabian/commits/master) for openHABian.
|
||||
You'll also see commits "fly by" when executing the "Update" function within the openHABian Configuration Tool.
|
||||
|
||||
<a id="successful"></a>
|
||||
|
|
@ -377,7 +454,8 @@ Watch the progress on the console or the web interface at https://<yourip>/ or <
|
|||
Double-check the IP address and name with your router while you wait.
|
||||
If there is absolutely no output for more than 10 minutes, your installation has failed in the first initialization phase. There probably is a problem
|
||||
with the way your router or local network are setup.
|
||||
Read on in the [Troubleshooting](#Troubleshooting) section or move on to the [DEBUG guide](https://github.com/openhab/openhabian/blob/master/docs/openhabian-DEBUG.md).
|
||||
Read on in the [Troubleshooting](#troubleshooting) section or move on to the [DEBUG guide](openhabian-DEBUG.md).
|
||||
You can set `debugmode=on` (or even = `maximum`) right on first install, too, to get to see what openHABian is doing.
|
||||
|
||||
After a few minutes of boot up time, you can [connect to the SSH console](https://www.raspberrypi.org/documentation/remote-access/ssh/windows.md) of your device.
|
||||
During the setup process you'll be redirected to the live progress report of the setup (you can Ctrl-C to get into the shell).
|
||||
|
|
@ -415,7 +493,7 @@ You can migrate between versions by selecting the corresponding 4X menu option.
|
|||
If you want to choose from stable, snapshot or milestone releases, please do so via `openhabian-config` tool (also menu 4X).
|
||||
Note this will **not** result in any openHABian branch change.
|
||||
Switching from stable to newer development releases might introduce changes and incompatibilities, so please be sure to make a full openHAB backup first!
|
||||
Check the Linux installation article for all needed details: [Linux: Changing Versions](https://www.openhab.org/docs/installation/linux.html#changing-versions)
|
||||
Check the Linux installation article for all needed details: [Linux: Changing Versions](linux.html#changing-versions)
|
||||
|
||||
<a id="headache"></a>
|
||||
#### Where is the graphical user interface?
|
||||
|
|
@ -429,19 +507,15 @@ Its intended use case is to sit in a corner and provide a service reliably 24 ho
|
|||
You already own a **powerful PC or Mac** to work on.
|
||||
It would be a shame to have a powerful computer at your fingertips and then have to **restrict yourself** to a very limited graphical frontend on another device, wouldn't you agree?
|
||||
|
||||
Moving on.
|
||||
What we actually want openHABian to be is a **dedicated headless system** to **reliably execute openHAB** and to **expose all interfaces** needed to interact and configure it (PaperUI, BasicUI, HABPanel, openHAB LogViewer, Samba Network Shares, openHABian Configuration Tool, SSH, you-name-it).
|
||||
What we actually want openHABian to be is a **dedicated, headless system** to **reliably run openHAB** and to **expose all interfaces** needed to interact and configure it (MainUI, HABPanel, openHAB LogViewer, Samba Network Shares, openHABian Configuration Tool, SSH, you-name-it).
|
||||
If you know how to work with these interfaces, you are set for a way better experience than the alternatives.
|
||||
The main challenge is to **get used to the Linux command line**, not even a GUI (like Pixel, see below) will relieve you from that in the long run.
|
||||
If you are not willing to teach yourself a few fundamental Linux skills you will not become happy with any Linux system and should resort to a e.g. Windows machine.
|
||||
However as you are willing to tinker with smart home technology, I'm sure you are ready to **teach yourself new stuff** and expand your experience.
|
||||
|
||||
**If** the above didn't convince you, execute the following commands to get the graphical user interface [Pixel](https://www.raspberrypi.org/blog/introducing-pixel) installed.
|
||||
You have been warned, if there came any warranty with openHABian to begin with, it would end here.
|
||||
|
||||
<a id="faq-other-platforms"></a>
|
||||
#### Can I use openHABian on ...?
|
||||
See the [README](https://github.com/openhab/openhabian/blob/master/README.md) for a list of supported HW and OS.
|
||||
See the [README](https://github.com/openhab/openhabian/blob/master/README.md#hardware-and-os-support) for a list of supported HW and OS.
|
||||
openHABian is developed for Debian based systems.
|
||||
If your operating system is based on these or if your hardware supports one, your chances are high openHABian can be used.
|
||||
Check out the [Manual Setup](#manual-setup) instructions for guidance and consult the [debug guide](openhabian-DEBUG.md) if you run into problems.
|
||||
|
|
|
|||
Loading…
Reference in New Issue