PiSignage Home Assistant Integration

A Custom Integration for Home Assistant to connect with PiSignage Server (Open Source or Hosted PiSignage.com)

Features

• Control PiSignage players
• Switch between playlists (Will Switch the default playlist for the group)
• Power on/off connected TVs with CEC
• Sensors for player data
• Two-factor authentication support

Installation

HACS (Recommended)

1. Ensure HACS is installed in your Home Assistant instance
2. Add this repository as a custom repository in HACS:
   • Go to HACS → Integrations → ⋮ (three dots) → Custom repositories
   • Add URL: https://github.com/rohanwright/ha-pisignage
   • Category: Integration
3. Click "Install" on the PiSignage integration
4. Restart Home Assistant

Manual Installation

1. Download this repository
2. Copy the custom_components/pisignage directory to your Home Assistant's custom_components directory
3. Restart Home Assistant

Configuration

1. Go to Home Assistant → Settings → Devices & Services → Add Integration
2. Search for "PiSignage" and select it
3. Enter your PiSignage server details:
   • Host: IP address or hostname of your PiSignage open source server, or the username of your hosted service (username.pisignage.com)
   • Port: Open Source Server port (default: 3000, Not needed for hosted)
   • Username: Your PiSignage username or email address
   • Password: Your PiSignage password
4. If two-factor authentication is enabled on your account, you'll be prompted to enter your OTP code
5. Click "Submit" to connect

Configuration Options

After initial setup, you can configure additional options:

1. Go to Home Assistant → Settings → Devices & Services
2. Find the PiSignage integration and click "Configure"
3. You can set the following options:
   • Ignore CEC Functionality: Select players for which CEC functionality should be disabled. Use this option if your player reports CEC support, but you want to ignore it for control purposes.

Two-Factor Authentication

This integration supports two-factor authentication (2FA) for PiSignage accounts that have it enabled. If your account has 2FA enabled:

1. During setup, enter your regular credentials first
2. The system will detect that 2FA is enabled and prompt you for your OTP code
3. Enter the OTP code from your authentication device/app
4. After successful verification, the integration will be configured

Note: OTP authentication is only required during initial setup and not for regular operation once the integration is configured.

Available Entities

For each PiSignage player, the integration creates a device with the name of the player. Connected to the device are the following entities:

Media Player

• Control the current playlist on the player (play/pause, next/previous item in the playlist)
• Select playlists from the source list which will update the primary playlist within the group and deploy
• Turn connected TV on/off with CEC if supported

Sensors

• Status: Shows the current player status (Playing, Not Playing, TV Powered Off, Offline)
• Current Playlist: Shows the playlist currently playing on the device
• Storage: Shows used storage space as a percentage
• Player IP: The local IP address of the player
• Location: The configured location in PiSignage

Services

play_playlist

Start playing a specific playlist on a PiSignage player.

Field	Type	Description
entity_id	string	The player entity ID
playlist	string	Name of the playlist to play

Example:

service: pisignage.play_playlist
target:
  entity_id: media_player.pisignage_lobby
data:
  playlist: "Welcome Playlist"

tv_control

Turn on or off the TV connected to the PiSignage player.

Field	Type	Description
entity_id	string	The player entity ID
status	string	Either "on" or "off"

Example:

service: pisignage.tv_control
target:
  entity_id: media_player.pisignage_lobby
data:
  status: "off"

Automation Blueprints

This integration includes ready-to-use automation blueprints to help you get started:

Installing the Blueprints

Blueprints must be manually installed. Follow these steps to install the included blueprints:

1. Go to Settings → Automations & Scenes → Blueprints
2. Click the "Import Blueprint" button in the bottom right
3. Enter one of the following URLs for the blueprint you want to install:
   • Power On Players: https://github.com/rohanwright/ha-pisignage/blob/main/custom_components/pisignage/blueprints/automation/power_on_players_blueprint.yaml
   • Power Off Players: https://github.com/rohanwright/ha-pisignage/blob/main/custom_components/pisignage/blueprints/automation/power_off_players_blueprint.yaml
   • Playlist Control: https://github.com/rohanwright/ha-pisignage/blob/main/custom_components/pisignage/blueprints/automation/playlist_control_blueprint.yaml
4. Click "Preview" to check the blueprint, then click "Import Blueprint"
5. The blueprint will now be available for creating automations

Alternatively, you can copy the blueprint YAML files from the custom_components/pisignage/blueprints/automation/ directory to your Home Assistant config/blueprints/automation/ directory.

Power On PiSignage Players

Blueprint to turn on multiple PiSignage players with a single automation.

1. Go to Settings → Automations & Scenes → Blueprints
2. Find the "Power On PiSignage Players" blueprint
3. Create a new automation using this blueprint
4. Select the PiSignage player entities you want to control

Power Off PiSignage Players

Blueprint to turn off multiple PiSignage players with a single automation.

Switch PiSignage Playlist

Blueprint to change the playlist on one or more PiSignage players.

Automation Examples

Turn on displays in the morning and off at night

# Morning automation
automation:
  - alias: "Turn on digital signage in the morning"
    trigger:
      - platform: time
        at: "08:00:00"
    action:
      - service: media_player.turn_on
        target:
          entity_id: media_player.pisignage_lobby

# Evening automation
  - alias: "Turn off digital signage at night"
    trigger:
      - platform: time
        at: "19:00:00"
    action:
      - service: media_player.turn_off
        target:
          entity_id: media_player.pisignage_lobby

Switch playlist based on time of day

automation:
  - alias: "Switch to morning playlist"
    trigger:
      - platform: time
        at: "08:00:00"
    action:
      - service: media_player.select_source
        target:
          entity_id: media_player.pisignage_lobby
        data:
          source: "Morning Announcements"

  - alias: "Switch to afternoon playlist"
    trigger:
      - platform: time
        at: "12:00:00"
    action:
      - service: media_player.select_source
        target:
          entity_id: media_player.pisignage_lobby
        data:
          source: "Afternoon Announcements"

Troubleshooting

• Connection Issues: Ensure your Home Assistant instance can reach your PiSignage server and that the credentials are correct.
• Missing Players: Make sure your players are registered with the PiSignage server and are online.
• Playlist Control: If playlist switching doesn't work, verify that the playlist names match exactly (case-sensitive).
• CEC Not Working: Check if your player has CEC support enabled. If CEC functionality is causing issues, you can disable it in the integration's configuration options.
• Two-Factor Authentication: If you're having issues with 2FA, make sure you're entering the correct OTP code during setup.

Credit

This integration was developed independently for the Home Assistant community. PiSignage is a product of Ariemtech Pvt. Ltd. This integration is not officially affiliated with or endorsed by Ariemtech.