.. include:: /index.rst :start-after: start_hello_message :end-before: end_hello_message .. _view_control_commands_mini: Control with Commands ======================================== In addition to viewing data from the Pironman 5 Mini and controlling various devices through the Dashboard, you can also use commands to control them. .. note:: * For the **Home Assistant** system, you can only monitor and control the Pironman 5 Mini through the dashboard by opening the webpage at ``http://:34001``. * It is important to note that any changes to the configuration require a restart of the service using ``pironman5 restart`` to take effect. View the Basic Configurations ----------------------------------- The ``pironman5`` module offers basic configurations for Pironman, which you can review with the following command. .. code-block:: shell sudo pironman5 -c The standard configurations appear as follows: .. code-block:: { "system": { "rgb_color": "feff00", "rgb_brightness": 30, "rgb_style": "hue_cycle", "rgb_speed": 50, "rgb_enable": true, "rgb_led_count": 12, "temperature_unit": "C", "gpio_fan_pin": 5, "gpio_fan_mode": 0, "gpio_fan_led": "follow", "gpio_fan_led_pin": 6 } } Customize these configurations to fit your needs. Use ``pironman5`` or ``pironman5 -h`` for instructions. .. code-block:: .. code-block:: usage: pironman5-service [-h] [-v] [-c] [-dl {debug,info,warning,error,critical}] [--background [BACKGROUND]] [-rd] [-cp [CONFIG_PATH]] [-u [{C,F}]] [-gm [GPIO_FAN_MODE]] [-gp [GPIO_FAN_PIN]] [-fl [GPIO_FAN_LED]] [-fp [GPIO_FAN_LED_PIN]] [{start,restart,stop}] Pironman 5 command line interface positional arguments: {start,restart,stop} Command options: -h, --help show this help message and exit -v, --version Show version -c, --config Show config -dl {debug,info,warning,error,critical}, --debug-level {debug,info,warning,error,critical} Debug level --background [BACKGROUND] Run in background -rd, --remove-dashboard Remove dashboard -cp [CONFIG_PATH], --config-path [CONFIG_PATH] Config path -u [{C,F}], --temperature-unit [{C,F}] Temperature unit -gm [GPIO_FAN_MODE], --gpio-fan-mode [GPIO_FAN_MODE] GPIO fan mode, 0: Always On, 1: Performance, 2: Cool, 3: Balanced, 4: Quiet -gp [GPIO_FAN_PIN], --gpio-fan-pin [GPIO_FAN_PIN] GPIO fan pin -fl [GPIO_FAN_LED], --gpio-fan-led [GPIO_FAN_LED] GPIO fan LED state on/off/follow -fp [GPIO_FAN_LED_PIN], --gpio-fan-led-pin [GPIO_FAN_LED_PIN] GPIO fan LED pin .. note:: Each time you modify the status of ``pironman5.service``, you need to use the following command to make the configuration changes take effect. .. code-block:: shell sudo systemctl restart pironman5.service * Verify the ``pironman5`` program status using the ``systemctl`` tool. .. code-block:: shell sudo systemctl status pironman5.service * Alternatively, inspect the program-generated log files. .. code-block:: shell ls /var/log/pironman5/ cat /var/log/pironman5/main.log Control RGB LEDs ---------------------- The board features 4 WS2812 RGB LEDs, offering customizable control. Users can turn them on or off, change the color, adjust the brightness, switch RGB LED display modes, and set the speed of changes. .. note:: Each time you modify the status of ``pironman5.service``, you need to use the following command to make the configuration changes take effect. .. code-block:: shell sudo systemctl restart pironman5.service * To modify the on and off state of the RGB LEDs, ``true`` to turn on the RGB LEDs, ``false`` to turn them off. .. code-block:: shell sudo pironman5 -re true * To change their color, input the desired hexadecimal color values, such as ``fe1a1a``. .. code-block:: shell sudo pironman5 -rc fe1a1a * To change the brightness of the RGB LED (range: 0 ~ 100%): .. code-block:: shell sudo pironman5 -rb 100 * To switch RGB LED display modes, choose from options: ``solid/breathing/flow/flow_reverse/rainbow/rainbow_reverse/hue_cycle``: .. note:: If you set the RGB LED display mode to ``rainbow``, ``rainbow_reverse``, or ``hue_cycle``, you will not be able to set the color using ``pironman5 -rc``. .. code-block:: shell sudo pironman5 -rs breathing * To modify the speed of change (range: 0 ~ 100%): .. code-block:: shell sudo pironman5 -rp 80 * The default setup includes 4 RGB LEDs. Connect additional LEDs and update the count using: .. code-block:: shell sudo pironman5 -rl 12 .. _cc_control_fan_mini: Control RGB Fan --------------------- The IO expansion board supports to a 5V non-PWM fan. .. note:: Each time you modify the status of ``pironman5.service``, you need to use the following command to make the configuration changes take effect. .. code-block:: shell sudo systemctl restart pironman5.service * You can use command to configure the operating mode of the RGB fan. These modes determine the conditions under which the RGB fan will activate. For instance, if set to **1: Performance** mode, the RGB fan will activate at 50°C. .. code-block:: shell sudo pironman5 -gm 3 * **4: Quiet**: The RGB fan will activate at 70°C. * **3: Balanced**: The RGB fan will activate at 67.5°C. * **2: Cool**: The RGB fan will activate at 60°C. * **1: Performance**: The RGB fan will activate at 50°C. * **0: Always On**: The RGB fan will always on. * If you connect the control pin of the RGB fan to different pins on the Raspberry Pi, you can use the following command to change the pin number. .. code-block:: shell sudo pironman5 -gp 18 **About Core Fan** The core fan connects to a dedicated 4-pin PWM fan port on the Raspberry Pi 5. Its default control strategy is a firmware-managed, multi-level intelligent speed adjustment scheme based on CPU temperature. This means that when you use an official or compatible PWM fan and connect it correctly, the system will automatically adjust the fan speed according to changes in CPU temperature (starting to operate above 50°C) without any manual intervention from you.