Sign inSign up

revnull/apex2mqtt

By revnull

•Updated over 4 years ago

Used to pull metrics from Neptune Systems Apex controllers and publish to a MQTT broker.

Image
0

1.5K

revnull/apex2mqtt repository overview

⁠apex2mqtt

This software acts as a bridge to pull metrics from Neptune Systems Apex controllers and publish them to a local MQTT broker. This functions completely on "apex.local" and has no interaction with the Apex Fusion cloud offering.

Note: I am not affiliated Neptune Systems or it's business partners in any way. I'm just a saltwater aquarium enthusiast with too much time on my hands. :) This software is provided "as-is" with no expressed or implied warranty. Use at your own risk.

⁠Requirements

Hardware:

Software:

⁠Running in Docker

  • Install docker and docker-compose on your machine

Docker CLI Example:

$ docker run -d \
    -e APEX_ADDRESS=<IP_ADDRESS> \
    -e MQTT_ADDRESS=<IP_ADDRESS> \
    -e HOME_ASSISTANT=<TRUE/FALSE> \
    -e TZ=<TIMEZONE> \
    --restart unless-stopped \
    revnull/apex2mqtt

Docker Compose Example:

version: "2.1"
services:
  apex2mqtt:
    image: revnull/apex2mqtt
    container_name: apex2mqtt
    environment:
      - APEX_ADDRESS=<IP_ADDRESS>,<IP_ADDRESS>
      - MQTT_ADDRESS=<IP_ADDRESS>
      - HOME_ASSISTANT=<TRUE/FALSE>
      - TZ=<TIMEZONE>
    depends_on:
      - <MQTT_BROKER_SERVICE>
    restart: unless-stopped

⁠Parameters

Docker Environment VARValueDefaultDescription
APEX_ADDRESSip addressNoneThe IP address of your Apex controller. Use comma with no spaces to monitor more than 1 controller.
APEX_PORTport number80Apex TCP port
APEX_USERusernameadminApex login username
APEX_PASSpassword1234Apex login password
MQTT_ADDRESSip addressNoneThe IP address of your MQTT broker
MQTT_PORTport number1883MQTT broker TCP port
MQTT_USERusernameNoneMQTT broker username
MQTT_PASSpasswordNoneMQTT broker password
INTERVALseconds5How often should we collect data?
HOME_ASSISTANTTrue/FalseFalsePublish Home Assistant auto discovery topics
LOG_LEVELcritical, error, warn, info, debuginfoConfigure logging level sent to console
TZLocal Timezone⁠UTCSpecify a timezone to use, US/Pacific for example. This is required for logging timestamps

Tag summary

Content type

Image

Digest

Size

23.8 MB

Last updated

over 4 years ago

docker pull revnull/apex2mqtt