mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 20:36:52 +00:00
Remove core specific documentation from integrations (#39311)
This commit is contained in:
Robert Resch
GitHub
parent
92f0b7edb0
commit
c441f2ec80
@ -25,9 +25,6 @@ Depending on the operating system you're running, you have to configure the prop
|
||||
|
||||
- `beewi_smartclim` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
|
||||
- Using [Home Assistant Container installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
|
||||
- On other Home Assistant Core systems:
|
||||
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
||||
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ The **Energenie Power-Sockets** {% term integration %} allows you to include [En
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you are running a {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %} installation: Depending on your system configuration, it may be necessary to grant explicit user access rights to the USB device by creating an udev rule.
|
||||
If you are running a {% term "Home Assistant Container" %} installation: Depending on your system configuration, it may be necessary to grant explicit user access rights to the USB device by creating an udev rule.
|
||||
|
||||
{% details "Creating an udev rule" %}
|
||||
|
||||
|
||||
@ -109,8 +109,6 @@ It is recommended to run the Matter add-on on Home Assistant OS. This is current
|
||||
|
||||
If you run Home Assistant in a container, you can run a Docker image of the [Matter server](https://github.com/home-assistant-libs/python-matter-server). The requirements and instructions for your host setup are described on that GitHub page.
|
||||
|
||||
Running Matter on a Home Assistant Core installation is not supported.
|
||||
|
||||
## Adding a Matter device to Home Assistant
|
||||
|
||||
Each Matter network is called a fabric. Each home automation controller that controls Matter devices has its own "fabric". You can add devices directly to the fabric of your Home Assistant instance, or share them from another fabric (for example from Google or Apple) to Home Assistant's fabric. We're going to explore all these options below.
|
||||
|
||||
@ -41,9 +41,6 @@ Home Assistant OS and Supervised users can access this folder by using,
|
||||
for example, the Samba add-on. Users of Home Assistant Container can
|
||||
mount a volume of their choice to `/media`.
|
||||
|
||||
If you are a Home Assistant Core user, the default directory called is called
|
||||
`media` under the configuration path (where your {% term "`configuration.yaml`" %} is located).
|
||||
|
||||
Files served from `media` are protected by Home Assistant authentication
|
||||
unlike those served from `www`.
|
||||
|
||||
|
||||
@ -30,10 +30,6 @@ The ONVIF camera integration allows you to use an [ONVIF](https://www.onvif.org/
|
||||
It is recommended that you create a user on your device specifically for Home Assistant. For all current functionality, it is enough to create a standard user.
|
||||
{% endtip %}
|
||||
|
||||
{% note %}
|
||||
If running Home Assistant Core in a venv, ensure that libxml2 and libxslt Python interfaces are installed via your package manager.
|
||||
{% endnote %}
|
||||
|
||||
### Configuration notes
|
||||
|
||||
Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H.264. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI.
|
||||
|
||||
@ -50,62 +50,6 @@ Do not run your <b>Home Assistant Core</b> instance itself as <b>root</b> or wit
|
||||
|
||||
There are varying methods to perform this, dependent on your OS that is running Home Assistant. Specifically, your *Python Interpreter*, which runs your Home Assistant instance, needs access to the mentioned ports.
|
||||
|
||||
{% note %}
|
||||
Additional configuration is only required for Home Assistant Core users **not** running on Docker.
|
||||
{% endnote %}
|
||||
|
||||
### Debian-based
|
||||
|
||||
Home Assistant installed on a Debian-type OS may require configuration. This section is applicable but not limited to the following operating systems:
|
||||
|
||||
- Debian
|
||||
- Raspbian
|
||||
- Armbian
|
||||
- Ubuntu
|
||||
|
||||
In terminal run the following command:
|
||||
|
||||
```bash
|
||||
sudo setcap 'cap_net_bind_service=+ep' <python>
|
||||
```
|
||||
|
||||
Replace `<python>` with your **system path** to Python that is running Home Assistant and/or your virtual environment if used. The path **should not** be a **symlink** or be **inside of a virtual environment**.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5
|
||||
```
|
||||
|
||||
To find your system Python path:
|
||||
|
||||
- Add the [System Health](/integrations/system_health/) integration to your {% term "`configuration.yaml`" %}. In a web browser, access your frontend and navigate to the about/logs page "http://<yourhomeassistanturl>/developer-tools/info). In the System Health box, locate the item **python_version** and note the value that is displayed. Then in a terminal run:
|
||||
|
||||
```bash
|
||||
whereis python<version>
|
||||
```
|
||||
|
||||
Replace `<version>` with the value for `python_version` that is shown in the System Health box.
|
||||
|
||||
Example:
|
||||
```bash
|
||||
whereis python3.5.3
|
||||
```
|
||||
|
||||
The output which has the directory `/bin/` is likely your system Python path which should look like this `/usr/bin/python3.5`
|
||||
|
||||
- If Home Assistant is installed in a virtual environment, use terminal to `cd` to the root/top directory of your environment and run:
|
||||
|
||||
```bash
|
||||
readlink -f bin/python3
|
||||
```
|
||||
or
|
||||
```bash
|
||||
readlink -f bin/python
|
||||
```
|
||||
|
||||
The output will be your system Python path.
|
||||
|
||||
### Docker
|
||||
|
||||
When running Home Assistant using Docker, make sure that the Home Assistant container is discoverable by the PS4. This can be achieved by ensuring that the Home Assistant container uses the `host` network driver (by passing `--net=host` to the container when creating, or adding `network_mode: "host"` to your compose file when using `docker-compose`).
|
||||
|
||||
@ -286,25 +286,3 @@ The unit of measurement returned by the above query is `MiB`, please configure t
|
||||
Set the device class to `Data size` so you can use UI unit conversion.
|
||||
{% endtip %}
|
||||
|
||||
#### MS SQL
|
||||
|
||||
Use the same Database URL as for the `recorder` integration. Change `DB_NAME` to the name that you use as the database name, to ensure that your sensor will work properly. Be sure `username` has enough rights to access the sys tables.
|
||||
|
||||
Example Database URL: `"mssql+pyodbc://username:password@SERVER_IP:1433/DB_NAME?charset=utf8&driver=FreeTDS"`
|
||||
|
||||
{% note %}
|
||||
Connecting with MSSQL requires "pyodbc" to be installed on your system, which can only be done on systems using the Home Assistant Core installation type to be able to install the necessary dependencies.
|
||||
|
||||
"pyodbc" has special requirements which need to be pre-installed before installation, see the ["pyodbc" wiki](https://github.com/mkleehammer/pyodbc/wiki/Install) for installation instructions
|
||||
{% endnote %}
|
||||
|
||||
```sql
|
||||
SELECT TOP 1 SUM(m.size) * 8 / 1024 as size FROM sys.master_files m INNER JOIN sys.databases d ON d.database_id=m.database_id WHERE d.name='DB_NAME';
|
||||
```
|
||||
Use `size` as column for value.
|
||||
|
||||
{% tip %}
|
||||
The unit of measurement returned by the above query is `MiB`, please configure this correctly.
|
||||
|
||||
Set the device class to `Data size` so you can use UI unit conversion.
|
||||
{% endtip %}
|
||||
|
||||
@ -20,6 +20,3 @@ This {% term integration %} discovers nearby Zerproc lights and adds them to Hom
|
||||
|
||||
The {% term integration %} will scan for nearby devices, and is completed if any are found. No additional configuration is required. The integration will perform a BLE scan every 60 seconds to search for new devices.
|
||||
|
||||
## Additional information for Home Assistant Core on Python environments
|
||||
|
||||
This {% term integration %} requires a working Bluetooth stack. Please refer to the [requirements of the underlying bleak library](https://bleak.readthedocs.io/en/latest/backends/index.html) for the operating system requirements.
|
||||
|
||||
@ -752,7 +752,7 @@ In addition to the [standard automation trigger data](/docs/automation/templatin
|
||||
|
||||
## Advanced installation instructions
|
||||
|
||||
If you are using Home Assistant Container, Home Assistant Core, or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect.
|
||||
If you are using Home Assistant Container or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect.
|
||||
|
||||
### Running [Z-Wave JS Server](https://github.com/zwave-js/zwave-js-server)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user