OilFox Binding for FoxInsights Customer API [4.0.0.0;5.0.0.0)

Add-on Marketplace Bundles
, ,
1

logo
logo395×440 42.1 KB

Binding for OilFox smart remote tank monitoring system.

This binding allows you to check the fuel level in your tank.

These are the information provided by the OilFox API (German screenshot):

image
image721×460 23.1 KB

Supported Things

Thing type Name
bridge OilFox Bridge
device OilFox Device
  • bridge: Connect OpenHAB to OilFox cloud server via FoxInsights Customer API
  • device: A OilFox tank fill level measuring hardware device

Discovery

An account must be specified in the OilFox bridge configuration, all OilFox devices for an account are discovered automatically.

Binding Configuration

There are several settings for an account:

Name Required Default Description
address yes api.oilfox.io OilFox Cloud server address
email yes Email registered on the OilFox Cloud
password yes Password registered on the OilFox Cloud
refresh yes 6 refresh interval in hours

Thing Configuration

device Thing Configuration

Name Required Default Description
hwid yes OilFox device hardware address

Channels

Channel Type Read/Write Description
hwid String readonly hardware ID of the device
currentMeteringAt DateTime readonly RFC3339 timestamp
nextMeteringAt DateTime readonly RFC3339 timestamp
daysReach Number readonly estimated days until the storage runs empty
batteryLevel String readonly enum of the battery level, see below
fillLevelPercent Number readonly fill level in %, 0-100
fillLevelQuantity Number readonly fill level in kg or L
quantityUnit String readonly unit of the fill level: kg or L

Enum batteryLevel

name description
FULL Full battery level
GOOD Good battery level
MEDIUM Medium battery level
WARNING Low battery level
CRITICAL Critical battery level

Full Example

Thing Configuration

Bridge oilfox:bridge:mybridge [ email="my-email@provider.com", password="my-password", refresh=8 ]
Thing oilfox:device:mybridge:mydevice "OilFox Device" (oilfox:bridge:mybridge) @ "Oiltank Room" [ hwid="XX123456789" ]

Item Configuration

DateTime Current_Metering_At "current metering at" {channel="oilfox:device:mybridge:mydevice:currentMeteringAt"}
DateTime Next_Metering_At "next metering at" {channel="oilfox:device:mybridge:mydevice:nextMeteringAt"}
Number Days_Reach "days reach" {channel="oilfox:device:mybridge:mydevice:daysReach", stateDescription=" "[ pattern="%.0f days" ]}
String Battery_Level "battery level" {channel="oilfox:device:mybridge:mydevice:batteryLevel"}
Number Fill_Level_Percent "fill level percent" {channel="oilfox:device:mybridge:mydevice:fillLevelPercent"}
Number Fill_Level_Quantity "fill level quantity" {channel="oilfox:device:mybridge:mydevice:fillLevelQuantity"}
String Quantity_Unit "quantity unit" {channel="oilfox:device:mybridge:mydevice:quantityUnit"}

Changelog

Version 25-05-10

  • fix refresh token

Version 25-05-09

  • fix device state after refresh token failed

Version 25-05-07

  • fix missing representation property

Version 25-05-05

  • initial release

Resources

The OilFox binding source code is hosted on GitHub
If you want to build the binding yourself use the Branch 4.3.x for openHAB 4.3.x and the branch master for openHAB 5.0.0.

Direkt download of jar files:

OilFox Binding for openHAB 4