### Get Start Up On Off Setting

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/SR-ZG9030A-MW.md

Publish a message to retrieve the current start up on/off setting. Possible values are last_state, on, and off.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/get
{"start_up_on_off": ""}
```

--------------------------------

### Start Zigbee2MQTT

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/05_windows.md

Run this command in the root directory of your Zigbee2MQTT installation to start the application.

```bash
pnpm start
```

--------------------------------

### Transition Example

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/5123.1110.md

To achieve a smooth transition for brightness or color temperature changes, include the 'transition' property in seconds within the payload.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{
  "brightness": 156,
  "transition": 3
}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{
  "color_temp": 241,
  "transition": 1
}
```

--------------------------------

### Install Python Packages (Debian)

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/adapters/flashing/flashing_via_cc2538-bsl.md

Install python3 and pip3 on Debian-based systems before proceeding with other setup steps.

```bash
sudo apt update && sudo apt install python3 python3-pip
```

--------------------------------

### Set Start Up On Off Setting

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/SR-ZG9030A-MW.md

Publish a message to set the start up on/off behavior. The default is last_state.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"start_up_on_off": NEW_VALUE}
```

--------------------------------

### Example Migration Notes (v1 to v2)

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/configuration/configuration-update.md

This log details changes made during a v1 to v2 configuration migration, including removals, transfers, and renames of settings.

```text
[REMOVAL] HA discovery_topic was moved from advanced.homeassistant_discovery_topic to homeassistant.discovery_topic.

[TRANSFER] Baudrate was moved from advanced.baudrate to serial.baudrate.

[REMOVAL] RTSCTS was moved from advanced.rtscts to serial.rtscts.

[TRANSFER] ban was renamed to passlist.

[CHANGE] Log level 'warn' has been renamed to 'warning'.

[ADDITION] Migrated settings to version 2

[REMOVAL] The MQTT legacy API has been removed (advanced.legacy_api setting). See link below for affected topics.

[REMOVAL] Retrieve state option ((devices|groups).xyz.retrieve_state setting)

For more details, see https://github.com/Koenkk/zigbee2mqtt/discussions/24198
```

--------------------------------

### Example Error Message

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/docker/docker_stack.md

This is an example of the error message observed in the service logs when a Docker container fails to start due to serial port access issues.

```text
Error: Error while opening serialport 'Error: Error: Operation not permitted, cannot open /dev/zigbee-serial'
```

--------------------------------

### Configure Light Level Settings

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/D1.md

Set composite light level configurations including transition time, on level, execute if off, and current level startup.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"level_config": {"on_off_transition_time": VALUE, "on_level": VALUE, "execute_if_off": VALUE, "current_level_startup": VALUE}}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/get
{"level_config": ""}
```

--------------------------------

### Launch openHABian Configuration Utility

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/04_openhabian.md

Use this command to start the openHABian configuration utility for managing installations and updates.

```bash
sudo openhabian-config
```

--------------------------------

### Enable Home Assistant Integration

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/configuration/homeassistant.md

Enables the Home Assistant MQTT discovery integration. This is the basic configuration required to get started.

```yaml
homeassistant:
    enabled: true
```

--------------------------------

### On with Timed Off and Transition Examples

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/RB_272_T.md

Set the light to turn on for a specified duration, with an optional cooldown period. Transitions can be applied to brightness and color temperature changes.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"state" : "ON", "on_time": 300}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"state" : "ON", "on_time": 300, "off_wait_time": 120}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"brightness":156,"transition":3}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp":241,"transition":1}
```

--------------------------------

### Set Startup Color Temperature

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/929003047401.md

Configure the color temperature that the light will use upon startup. Accepts numeric mired values or descriptive terms, including 'previous' to recall the last setting. Use GET to read the current configuration.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set: {"color_temp_startup": VALUE}
zigbee2mqtt/FRIENDLY_NAME/get: {"color_temp_startup": ""}
zigbee2mqtt/FRIENDLY_NAME/set: {"color_temp_startup": "previous"}
```

--------------------------------

### Configure ser2net (>=4.0)

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/advanced/remote-adapter/connect_to_a_remote_adapter.md

Edit the ser2net configuration file using YAML format for versions 4.0 and above. This example shows a basic TCP connection setup.

```bash
sudo nano /etc/ser2net.yaml
```

```yaml
connection: &con01
  accepter: tcp,20108
  connector: serialdev,/dev/ttyACM0,115200n81,local
  options:
    kickolduser: true
```

--------------------------------

### Create Docker Event Listener Script

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/docker/docker_stack.md

This script listens for Docker container start events and triggers the Zigbee serial adapter setup. It requires execute permissions.

```shell
#!/bin/bash
docker events --filter 'event=start'| \
while read line; do
	/usr/local/bin/docker-setup-zigbee-serial.sh
done
```

--------------------------------

### Set Power-on Behavior to On

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/3802964.md

Configure the device to turn on automatically when power is restored.

```mqtt
mosquitto_pub -h localhost -t 'zigbee2mqtt/FRIENDLY_NAME/set' -m '{"power_on_behavior": "on"}'
```

--------------------------------

### Set Light Startup Color Temperature

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/046677578138.md

Publish messages to set the startup color temperature. Use the /get topic to read the current startup color temperature.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp_startup": VALUE}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/get
{"color_temp_startup": ""}
```

--------------------------------

### Home Assistant Automation for Curtain Calibration

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/ZNCLDJ11LM.md

Example Home Assistant automation to calibrate the Aqara ZNCLDJ11LM curtain controller on system start. It publishes MQTT commands to reset limits, close, and then open the curtain.

```yaml
- id: "<Automation_ID>"
  alias: Calibrate curtain
  description: "Calibrate curtain"
  triggers:
    - trigger: homeassistant
      event: start
  conditions: []
  actions:
    - action: mqtt.publish
      metadata: {}
      data:
        topic: zigbee2mqtt/<FRIENDLY_NAME>/set
        payload: >-
          {{ {'options': {'reset_limits': true}} | tojson }}
    - action: cover.close_cover
      metadata: {}
      data: {}
      target:
        device_id: <COVER_ID>
    - delay:
        hours: 0
        minutes: 0
        seconds: 13
        milliseconds: 0
    - action: cover.open_cover
      metadata: {}
      data: {}
      target:
        device_id: <COVER_ID>
```

--------------------------------

### Set Light Startup Color Temperature

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/756200030.md

Configure the color temperature that the light should use upon startup. Supports numeric values or descriptive terms. Read the current setting with a GET request.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp_startup_11": VALUE}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/get
{"color_temp_startup_11": ""}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp_startup_11": "previous"}
```

--------------------------------

### Install and Run Docgen

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/README.md

Installs dependencies and runs the docgen script for generating device pages. Ensure Node.js and NPM are installed.

```bash
pnpm install

pnpm i --frozen-lockfile

pnpm run docgen
```

--------------------------------

### Start Zigbee2MQTT Container with Docker Compose

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/02_docker.md

Command to start the Zigbee2MQTT container in detached mode. You can omit the service name to start all containers.

```bash
docker compose up -d zigbee2mqtt
```

--------------------------------

### Configure Power-on Behavior

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/E1836.md

Set the device's behavior after a power loss. Publish to the 'set' topic with the desired behavior. Use the 'get' topic to read the current setting.

```mqtt
Topic: zigbee2mqtt/FRIENDLY_NAME/get
Payload: {"power_on_behavior": ""}

Topic: zigbee2mqtt/FRIENDLY_NAME/set
Payload: {"power_on_behavior": "NEW_VALUE"}
```

--------------------------------

### Clone and Install Zigbee2MQTT in FreeBSD Jail

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/guide/installation/06_freebsd_jail.md

Creates an installation directory, clones the Zigbee2MQTT repository, and installs its dependencies using pnpm. Builds the project.

```bash
# Create installation folder (/usr/local prefix is used for software not part of the base system)
mkdir -p /usr/local/opt/zigbee2mqtt
cd /usr/local/opt/zigbee2mqtt

# Clone Zigbee2MQTT repository
git clone --depth 1 https://github.com/Koenkk/zigbee2mqtt.git .

# Install dependencies
pnpm install --frozen-lockfile

# Build Zigbee2MQTT
pnpm run build
```

--------------------------------

### Set Startup Color Temperature

Source: https://github.com/koenkk/zigbee2mqtt.io/blob/master/docs/devices/100.491.61.md

Configure the color temperature that the light will use upon startup. Accepts numeric values or keywords, and can also recall the previous setting. Read the current startup setting.

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp_startup": VALUE}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/set
{"color_temp_startup": "previous"}
```

```mqtt
zigbee2mqtt/FRIENDLY_NAME/get
{"color_temp_startup": ""}
```