remove files from backup
This commit is contained in:
parent
e0b0a0ab70
commit
e57ef2bb60
|
@ -0,0 +1,55 @@
|
||||||
|
import serial
|
||||||
|
import logging
|
||||||
|
|
||||||
|
# dbus configuration
|
||||||
|
|
||||||
|
FIRMWARE_VERSION = 1 # value returned by getValue (getText returns string value reported by battery)
|
||||||
|
HARDWARE_VERSION = 1 # value returned by getValue (getText returns string value reported by battery)
|
||||||
|
|
||||||
|
CONNECTION = 'Modbus RTU'
|
||||||
|
PRODUCT_NAME = 'FZS 48TL200'
|
||||||
|
PRODUCT_ID = 0xB012 # assigned by victron
|
||||||
|
DEVICE_INSTANCE = 1
|
||||||
|
SERVICE_NAME_PREFIX = 'com.victronenergy.battery.'
|
||||||
|
|
||||||
|
#s3 configuration
|
||||||
|
S3BUCKET = "2-c0436b6a-d276-4cd8-9c44-1eae86cf5d0e"
|
||||||
|
S3KEY = "EXO5b2e35442791260eaaa7bdc8"
|
||||||
|
S3SECRET = "XFFOVzenDiEQoLPmhK6ML9RfQfsAMhrAs25MfJxi-24"
|
||||||
|
|
||||||
|
# driver configuration
|
||||||
|
|
||||||
|
SOFTWARE_VERSION = '3.0.3'
|
||||||
|
UPDATE_INTERVAL = 2000 # milliseconds
|
||||||
|
#LOG_LEVEL = logging.INFO
|
||||||
|
LOG_LEVEL = logging.DEBUG
|
||||||
|
|
||||||
|
# modbus configuration
|
||||||
|
|
||||||
|
BASE_ADDRESS = 999
|
||||||
|
#NO_OF_REGISTERS = 63
|
||||||
|
NO_OF_REGISTERS = 64
|
||||||
|
MAX_SLAVE_ADDRESS = 10
|
||||||
|
|
||||||
|
|
||||||
|
# RS 485 configuration
|
||||||
|
|
||||||
|
PARITY = serial.PARITY_ODD
|
||||||
|
TIMEOUT = 0.1 # seconds
|
||||||
|
BAUD_RATE = 115200
|
||||||
|
BYTE_SIZE = 8
|
||||||
|
STOP_BITS = 1
|
||||||
|
MODE = 'rtu'
|
||||||
|
|
||||||
|
|
||||||
|
# battery configuration
|
||||||
|
|
||||||
|
MAX_CHARGE_VOLTAGE = 58
|
||||||
|
I_MAX_PER_STRING = 15
|
||||||
|
NUM_OF_STRING_PER_BATTERY = 5
|
||||||
|
AH_PER_STRING = 40
|
||||||
|
V_MAX = 54.2
|
||||||
|
R_STRING_MIN = 0.125
|
||||||
|
R_STRING_MAX = 0.250
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,119 @@
|
||||||
|
from collections import Iterable
|
||||||
|
from decimal import *
|
||||||
|
|
||||||
|
import config as cfg
|
||||||
|
from data import LedState, BatteryStatus
|
||||||
|
|
||||||
|
# trick the pycharm type-checker into thinking Callable is in scope, not used at runtime
|
||||||
|
# noinspection PyUnreachableCode
|
||||||
|
if False:
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
|
||||||
|
def read_bool(register, bit):
|
||||||
|
# type: (int, int) -> Callable[[BatteryStatus], bool]
|
||||||
|
|
||||||
|
def get_value(status):
|
||||||
|
# type: (BatteryStatus) -> bool
|
||||||
|
value = status.modbus_data[register - cfg.BASE_ADDRESS]
|
||||||
|
return value & (1 << bit) > 0
|
||||||
|
|
||||||
|
return get_value
|
||||||
|
|
||||||
|
|
||||||
|
def read_float(register, scale_factor=1.0, offset=0.0, places=2):
|
||||||
|
# type: (int, float, float) -> Callable[[BatteryStatus], float]
|
||||||
|
|
||||||
|
def get_value(status):
|
||||||
|
# type: (BatteryStatus) -> float
|
||||||
|
value = status.modbus_data[register - cfg.BASE_ADDRESS]
|
||||||
|
|
||||||
|
if value >= 0x8000: # convert to signed int16
|
||||||
|
value -= 0x10000 # fiamm stores their integers signed AND with sign-offset @#%^&!
|
||||||
|
|
||||||
|
result = (value+offset)*scale_factor
|
||||||
|
return round(result,places)
|
||||||
|
|
||||||
|
return get_value
|
||||||
|
|
||||||
|
|
||||||
|
def read_hex_string(register, count):
|
||||||
|
# type: (int, int) -> Callable[[BatteryStatus], str]
|
||||||
|
"""
|
||||||
|
reads count consecutive modbus registers from start_address,
|
||||||
|
and returns a hex representation of it:
|
||||||
|
e.g. for count=4: DEAD BEEF DEAD BEEF.
|
||||||
|
"""
|
||||||
|
start = register - cfg.BASE_ADDRESS
|
||||||
|
end = start + count
|
||||||
|
|
||||||
|
def get_value(status):
|
||||||
|
# type: (BatteryStatus) -> str
|
||||||
|
return ' '.join(['{0:0>4X}'.format(x) for x in status.modbus_data[start:end]])
|
||||||
|
|
||||||
|
return get_value
|
||||||
|
|
||||||
|
|
||||||
|
def read_led_state(register, led):
|
||||||
|
# type: (int, int) -> Callable[[BatteryStatus], int]
|
||||||
|
|
||||||
|
read_lo = read_bool(register, led * 2)
|
||||||
|
read_hi = read_bool(register, led * 2 + 1)
|
||||||
|
|
||||||
|
def get_value(status):
|
||||||
|
# type: (BatteryStatus) -> int
|
||||||
|
|
||||||
|
lo = read_lo(status)
|
||||||
|
hi = read_hi(status)
|
||||||
|
|
||||||
|
if hi:
|
||||||
|
if lo:
|
||||||
|
return LedState.blinking_fast
|
||||||
|
else:
|
||||||
|
return LedState.blinking_slow
|
||||||
|
else:
|
||||||
|
if lo:
|
||||||
|
return LedState.on
|
||||||
|
else:
|
||||||
|
return LedState.off
|
||||||
|
|
||||||
|
return get_value
|
||||||
|
|
||||||
|
|
||||||
|
def read_bitmap(register):
|
||||||
|
# type: (int) -> Callable[[BatteryStatus], bitmap]
|
||||||
|
|
||||||
|
def get_value(status):
|
||||||
|
# type: (BatteryStatus) -> bitmap
|
||||||
|
value = status.modbus_data[register - cfg.BASE_ADDRESS]
|
||||||
|
return value
|
||||||
|
|
||||||
|
return get_value
|
||||||
|
|
||||||
|
|
||||||
|
def append_unit(unit):
|
||||||
|
# type: (unicode) -> Callable[[unicode], unicode]
|
||||||
|
|
||||||
|
def get_text(v):
|
||||||
|
# type: (unicode) -> unicode
|
||||||
|
return "{0}{1}".format(str(v), unit)
|
||||||
|
|
||||||
|
return get_text
|
||||||
|
|
||||||
|
|
||||||
|
def mean(numbers):
|
||||||
|
# type: (Iterable[float] | Iterable[int]) -> float
|
||||||
|
return float("{:.2f}".format(float(sum(numbers)) / len(numbers)))
|
||||||
|
|
||||||
|
def ssum(numbers):
|
||||||
|
# type: (Iterable[float] | Iterable[int]) -> float
|
||||||
|
return float("{:.2f}".format(float(sum(numbers))))
|
||||||
|
|
||||||
|
|
||||||
|
def first(ts):
|
||||||
|
return next(t for t in ts)
|
||||||
|
|
||||||
|
def return_in_list(ts):
|
||||||
|
return ts
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,97 @@
|
||||||
|
import config as cfg
|
||||||
|
from collections import Iterable
|
||||||
|
|
||||||
|
# trick the pycharm type-checker into thinking Callable is in scope, not used at runtime
|
||||||
|
# noinspection PyUnreachableCode
|
||||||
|
if False:
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
|
||||||
|
class LedState(object):
|
||||||
|
"""
|
||||||
|
from page 6 of the '48TLxxx ModBus Protocol doc'
|
||||||
|
"""
|
||||||
|
off = 0
|
||||||
|
on = 1
|
||||||
|
blinking_slow = 2
|
||||||
|
blinking_fast = 3
|
||||||
|
|
||||||
|
|
||||||
|
class LedColor(object):
|
||||||
|
green = 0
|
||||||
|
amber = 1
|
||||||
|
blue = 2
|
||||||
|
red = 3
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
class CsvSignal(object):
|
||||||
|
def __init__(self, name, get_value, get_text = None):
|
||||||
|
self.name = name
|
||||||
|
self.get_value = get_value if callable(get_value) else lambda _: get_value
|
||||||
|
self.get_text = get_text
|
||||||
|
|
||||||
|
if get_text is None:
|
||||||
|
self.get_text = ""
|
||||||
|
|
||||||
|
class Signal(object):
|
||||||
|
|
||||||
|
def __init__(self, dbus_path, aggregate, get_value, get_text=None):
|
||||||
|
# type: (str, Callable[[Iterable[object]],object], Callable[[BatteryStatus],object] | object, Callable[[object],unicode] | object)->None
|
||||||
|
"""
|
||||||
|
A Signal holds all information necessary for the handling of a
|
||||||
|
certain datum (e.g. voltage) published by the battery.
|
||||||
|
|
||||||
|
:param dbus_path: str
|
||||||
|
object_path on DBus where the datum needs to be published
|
||||||
|
|
||||||
|
:param aggregate: Iterable[object] -> object
|
||||||
|
function that combines the values of multiple batteries into one.
|
||||||
|
e.g. sum for currents, or mean for voltages
|
||||||
|
|
||||||
|
:param get_value: (BatteryStatus) -> object
|
||||||
|
function to extract the datum from the modbus record,
|
||||||
|
alternatively: a constant
|
||||||
|
|
||||||
|
:param get_text: (object) -> unicode [optional]
|
||||||
|
function to render datum to text, needed by DBus
|
||||||
|
alternatively: a constant
|
||||||
|
"""
|
||||||
|
|
||||||
|
self.dbus_path = dbus_path
|
||||||
|
self.aggregate = aggregate
|
||||||
|
self.get_value = get_value if callable(get_value) else lambda _: get_value
|
||||||
|
self.get_text = get_text if callable(get_text) else lambda _: str(get_text)
|
||||||
|
|
||||||
|
# if no 'get_text' provided use 'default_text' if available, otherwise str()
|
||||||
|
if get_text is None:
|
||||||
|
self.get_text = str
|
||||||
|
|
||||||
|
|
||||||
|
class Battery(object):
|
||||||
|
|
||||||
|
""" Data record to hold hardware and firmware specs of the battery """
|
||||||
|
|
||||||
|
def __init__(self, slave_address, hardware_version, firmware_version, bms_version, ampere_hours):
|
||||||
|
# type: (int, str, str, str, int) -> None
|
||||||
|
self.slave_address = slave_address
|
||||||
|
self.hardware_version = hardware_version
|
||||||
|
self.firmware_version = firmware_version
|
||||||
|
self.bms_version = bms_version
|
||||||
|
self.ampere_hours = ampere_hours
|
||||||
|
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return 'slave address = {0}\nhardware version = {1}\nfirmware version = {2}\nbms version = {3}\nampere hours = {4}'.format(
|
||||||
|
self.slave_address, self.hardware_version, self.firmware_version, self.bms_version, str(self.ampere_hours))
|
||||||
|
|
||||||
|
|
||||||
|
class BatteryStatus(object):
|
||||||
|
"""
|
||||||
|
record holding the current status of a battery
|
||||||
|
"""
|
||||||
|
def __init__(self, battery, modbus_data):
|
||||||
|
# type: (Battery, list[int]) -> None
|
||||||
|
|
||||||
|
self.battery = battery
|
||||||
|
self.modbus_data = modbus_data
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,276 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
import sys
|
||||||
|
from traceback import print_exc
|
||||||
|
from os import _exit as os_exit
|
||||||
|
from os import statvfs
|
||||||
|
from subprocess import check_output, CalledProcessError
|
||||||
|
import logging
|
||||||
|
import dbus
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
VEDBUS_INVALID = dbus.Array([], signature=dbus.Signature('i'), variant_level=1)
|
||||||
|
|
||||||
|
class NoVrmPortalIdError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Use this function to make sure the code quits on an unexpected exception. Make sure to use it
|
||||||
|
# when using GLib.idle_add and also GLib.timeout_add.
|
||||||
|
# Without this, the code will just keep running, since GLib does not stop the mainloop on an
|
||||||
|
# exception.
|
||||||
|
# Example: GLib.idle_add(exit_on_error, myfunc, arg1, arg2)
|
||||||
|
def exit_on_error(func, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return func(*args, **kwargs)
|
||||||
|
except:
|
||||||
|
try:
|
||||||
|
print ('exit_on_error: there was an exception. Printing stacktrace will be tried and then exit')
|
||||||
|
print_exc()
|
||||||
|
except:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# sys.exit() is not used, since that throws an exception, which does not lead to a program
|
||||||
|
# halt when used in a dbus callback, see connection.py in the Python/Dbus libraries, line 230.
|
||||||
|
os_exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
__vrm_portal_id = None
|
||||||
|
def get_vrm_portal_id():
|
||||||
|
# The original definition of the VRM Portal ID is that it is the mac
|
||||||
|
# address of the onboard- ethernet port (eth0), stripped from its colons
|
||||||
|
# (:) and lower case. This may however differ between platforms. On Venus
|
||||||
|
# the task is therefore deferred to /sbin/get-unique-id so that a
|
||||||
|
# platform specific method can be easily defined.
|
||||||
|
#
|
||||||
|
# If /sbin/get-unique-id does not exist, then use the ethernet address
|
||||||
|
# of eth0. This also handles the case where velib_python is used as a
|
||||||
|
# package install on a Raspberry Pi.
|
||||||
|
#
|
||||||
|
# On a Linux host where the network interface may not be eth0, you can set
|
||||||
|
# the VRM_IFACE environment variable to the correct name.
|
||||||
|
|
||||||
|
global __vrm_portal_id
|
||||||
|
|
||||||
|
if __vrm_portal_id:
|
||||||
|
return __vrm_portal_id
|
||||||
|
|
||||||
|
portal_id = None
|
||||||
|
|
||||||
|
# First try the method that works if we don't have a data partition. This
|
||||||
|
# will fail when the current user is not root.
|
||||||
|
try:
|
||||||
|
portal_id = check_output("/sbin/get-unique-id").decode("utf-8", "ignore").strip()
|
||||||
|
if not portal_id:
|
||||||
|
raise NoVrmPortalIdError("get-unique-id returned blank")
|
||||||
|
__vrm_portal_id = portal_id
|
||||||
|
return portal_id
|
||||||
|
except CalledProcessError:
|
||||||
|
# get-unique-id returned non-zero
|
||||||
|
raise NoVrmPortalIdError("get-unique-id returned non-zero")
|
||||||
|
except OSError:
|
||||||
|
# File doesn't exist, use fallback
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Fall back to getting our id using a syscall. Assume we are on linux.
|
||||||
|
# Allow the user to override what interface is used using an environment
|
||||||
|
# variable.
|
||||||
|
import fcntl, socket, struct, os
|
||||||
|
|
||||||
|
iface = os.environ.get('VRM_IFACE', 'eth0').encode('ascii')
|
||||||
|
s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
||||||
|
try:
|
||||||
|
info = fcntl.ioctl(s.fileno(), 0x8927, struct.pack('256s', iface[:15]))
|
||||||
|
except IOError:
|
||||||
|
raise NoVrmPortalIdError("ioctl failed for eth0")
|
||||||
|
|
||||||
|
__vrm_portal_id = info[18:24].hex()
|
||||||
|
return __vrm_portal_id
|
||||||
|
|
||||||
|
|
||||||
|
# See VE.Can registers - public.docx for definition of this conversion
|
||||||
|
def convert_vreg_version_to_readable(version):
|
||||||
|
def str_to_arr(x, length):
|
||||||
|
a = []
|
||||||
|
for i in range(0, len(x), length):
|
||||||
|
a.append(x[i:i+length])
|
||||||
|
return a
|
||||||
|
|
||||||
|
x = "%x" % version
|
||||||
|
x = x.upper()
|
||||||
|
|
||||||
|
if len(x) == 5 or len(x) == 3 or len(x) == 1:
|
||||||
|
x = '0' + x
|
||||||
|
|
||||||
|
a = str_to_arr(x, 2);
|
||||||
|
|
||||||
|
# remove the first 00 if there are three bytes and it is 00
|
||||||
|
if len(a) == 3 and a[0] == '00':
|
||||||
|
a.remove(0);
|
||||||
|
|
||||||
|
# if we have two or three bytes now, and the first character is a 0, remove it
|
||||||
|
if len(a) >= 2 and a[0][0:1] == '0':
|
||||||
|
a[0] = a[0][1];
|
||||||
|
|
||||||
|
result = ''
|
||||||
|
for item in a:
|
||||||
|
result += ('.' if result != '' else '') + item
|
||||||
|
|
||||||
|
|
||||||
|
result = 'v' + result
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def get_free_space(path):
|
||||||
|
result = -1
|
||||||
|
|
||||||
|
try:
|
||||||
|
s = statvfs(path)
|
||||||
|
result = s.f_frsize * s.f_bavail # Number of free bytes that ordinary users
|
||||||
|
except Exception as ex:
|
||||||
|
logger.info("Error while retrieving free space for path %s: %s" % (path, ex))
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _get_sysfs_machine_name():
|
||||||
|
try:
|
||||||
|
with open('/sys/firmware/devicetree/base/model', 'r') as f:
|
||||||
|
return f.read().rstrip('\x00')
|
||||||
|
except IOError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Returns None if it cannot find a machine name. Otherwise returns the string
|
||||||
|
# containing the name
|
||||||
|
def get_machine_name():
|
||||||
|
# First try calling the venus utility script
|
||||||
|
try:
|
||||||
|
return check_output("/usr/bin/product-name").strip().decode('UTF-8')
|
||||||
|
except (CalledProcessError, OSError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Fall back to sysfs
|
||||||
|
name = _get_sysfs_machine_name()
|
||||||
|
if name is not None:
|
||||||
|
return name
|
||||||
|
|
||||||
|
# Fall back to venus build machine name
|
||||||
|
try:
|
||||||
|
with open('/etc/venus/machine', 'r', encoding='UTF-8') as f:
|
||||||
|
return f.read().strip()
|
||||||
|
except IOError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def get_product_id():
|
||||||
|
""" Find the machine ID and return it. """
|
||||||
|
|
||||||
|
# First try calling the venus utility script
|
||||||
|
try:
|
||||||
|
return check_output("/usr/bin/product-id").strip().decode('UTF-8')
|
||||||
|
except (CalledProcessError, OSError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Fall back machine name mechanism
|
||||||
|
name = _get_sysfs_machine_name()
|
||||||
|
return {
|
||||||
|
'Color Control GX': 'C001',
|
||||||
|
'Venus GX': 'C002',
|
||||||
|
'Octo GX': 'C006',
|
||||||
|
'EasySolar-II': 'C007',
|
||||||
|
'MultiPlus-II': 'C008',
|
||||||
|
'Maxi GX': 'C009',
|
||||||
|
'Cerbo GX': 'C00A'
|
||||||
|
}.get(name, 'C003') # C003 is Generic
|
||||||
|
|
||||||
|
|
||||||
|
# Returns False if it cannot open the file. Otherwise returns its rstripped contents
|
||||||
|
def read_file(path):
|
||||||
|
content = False
|
||||||
|
|
||||||
|
try:
|
||||||
|
with open(path, 'r') as f:
|
||||||
|
content = f.read().rstrip()
|
||||||
|
except Exception as ex:
|
||||||
|
logger.debug("Error while reading %s: %s" % (path, ex))
|
||||||
|
|
||||||
|
return content
|
||||||
|
|
||||||
|
|
||||||
|
def wrap_dbus_value(value):
|
||||||
|
if value is None:
|
||||||
|
return VEDBUS_INVALID
|
||||||
|
if isinstance(value, float):
|
||||||
|
return dbus.Double(value, variant_level=1)
|
||||||
|
if isinstance(value, bool):
|
||||||
|
return dbus.Boolean(value, variant_level=1)
|
||||||
|
if isinstance(value, int):
|
||||||
|
try:
|
||||||
|
return dbus.Int32(value, variant_level=1)
|
||||||
|
except OverflowError:
|
||||||
|
return dbus.Int64(value, variant_level=1)
|
||||||
|
if isinstance(value, str):
|
||||||
|
return dbus.String(value, variant_level=1)
|
||||||
|
if isinstance(value, list):
|
||||||
|
if len(value) == 0:
|
||||||
|
# If the list is empty we cannot infer the type of the contents. So assume unsigned integer.
|
||||||
|
# A (signed) integer is dangerous, because an empty list of signed integers is used to encode
|
||||||
|
# an invalid value.
|
||||||
|
return dbus.Array([], signature=dbus.Signature('u'), variant_level=1)
|
||||||
|
return dbus.Array([wrap_dbus_value(x) for x in value], variant_level=1)
|
||||||
|
if isinstance(value, dict):
|
||||||
|
# Wrapping the keys of the dictionary causes D-Bus errors like:
|
||||||
|
# 'arguments to dbus_message_iter_open_container() were incorrect,
|
||||||
|
# assertion "(type == DBUS_TYPE_ARRAY && contained_signature &&
|
||||||
|
# *contained_signature == DBUS_DICT_ENTRY_BEGIN_CHAR) || (contained_signature == NULL ||
|
||||||
|
# _dbus_check_is_valid_signature (contained_signature))" failed in file ...'
|
||||||
|
return dbus.Dictionary({(k, wrap_dbus_value(v)) for k, v in value.items()}, variant_level=1)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
dbus_int_types = (dbus.Int32, dbus.UInt32, dbus.Byte, dbus.Int16, dbus.UInt16, dbus.UInt32, dbus.Int64, dbus.UInt64)
|
||||||
|
|
||||||
|
|
||||||
|
def unwrap_dbus_value(val):
|
||||||
|
"""Converts D-Bus values back to the original type. For example if val is of type DBus.Double,
|
||||||
|
a float will be returned."""
|
||||||
|
if isinstance(val, dbus_int_types):
|
||||||
|
return int(val)
|
||||||
|
if isinstance(val, dbus.Double):
|
||||||
|
return float(val)
|
||||||
|
if isinstance(val, dbus.Array):
|
||||||
|
v = [unwrap_dbus_value(x) for x in val]
|
||||||
|
return None if len(v) == 0 else v
|
||||||
|
if isinstance(val, (dbus.Signature, dbus.String)):
|
||||||
|
return str(val)
|
||||||
|
# Python has no byte type, so we convert to an integer.
|
||||||
|
if isinstance(val, dbus.Byte):
|
||||||
|
return int(val)
|
||||||
|
if isinstance(val, dbus.ByteArray):
|
||||||
|
return "".join([bytes(x) for x in val])
|
||||||
|
if isinstance(val, (list, tuple)):
|
||||||
|
return [unwrap_dbus_value(x) for x in val]
|
||||||
|
if isinstance(val, (dbus.Dictionary, dict)):
|
||||||
|
# Do not unwrap the keys, see comment in wrap_dbus_value
|
||||||
|
return dict([(x, unwrap_dbus_value(y)) for x, y in val.items()])
|
||||||
|
if isinstance(val, dbus.Boolean):
|
||||||
|
return bool(val)
|
||||||
|
return val
|
||||||
|
|
||||||
|
# When supported, only name owner changes for the the given namespace are reported. This
|
||||||
|
# prevents spending cpu time at irrelevant changes, like scripts accessing the bus temporarily.
|
||||||
|
def add_name_owner_changed_receiver(dbus, name_owner_changed, namespace="com.victronenergy"):
|
||||||
|
# support for arg0namespace is submitted upstream, but not included at the time of
|
||||||
|
# writing, Venus OS does support it, so try if it works.
|
||||||
|
if namespace is None:
|
||||||
|
dbus.add_signal_receiver(name_owner_changed, signal_name='NameOwnerChanged')
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
dbus.add_signal_receiver(name_owner_changed,
|
||||||
|
signal_name='NameOwnerChanged', arg0namespace=namespace)
|
||||||
|
except TypeError:
|
||||||
|
dbus.add_signal_receiver(name_owner_changed, signal_name='NameOwnerChanged')
|
|
@ -0,0 +1,614 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
import dbus.service
|
||||||
|
import logging
|
||||||
|
import traceback
|
||||||
|
import os
|
||||||
|
import weakref
|
||||||
|
from collections import defaultdict
|
||||||
|
from ve_utils import wrap_dbus_value, unwrap_dbus_value
|
||||||
|
|
||||||
|
# vedbus contains three classes:
|
||||||
|
# VeDbusItemImport -> use this to read data from the dbus, ie import
|
||||||
|
# VeDbusItemExport -> use this to export data to the dbus (one value)
|
||||||
|
# VeDbusService -> use that to create a service and export several values to the dbus
|
||||||
|
|
||||||
|
# Code for VeDbusItemImport is copied from busitem.py and thereafter modified.
|
||||||
|
# All projects that used busitem.py need to migrate to this package. And some
|
||||||
|
# projects used to define there own equivalent of VeDbusItemExport. Better to
|
||||||
|
# use VeDbusItemExport, or even better the VeDbusService class that does it all for you.
|
||||||
|
|
||||||
|
# TODOS
|
||||||
|
# 1 check for datatypes, it works now, but not sure if all is compliant with
|
||||||
|
# com.victronenergy.BusItem interface definition. See also the files in
|
||||||
|
# tests_and_examples. And see 'if type(v) == dbus.Byte:' on line 102. Perhaps
|
||||||
|
# something similar should also be done in VeDbusBusItemExport?
|
||||||
|
# 2 Shouldn't VeDbusBusItemExport inherit dbus.service.Object?
|
||||||
|
# 7 Make hard rules for services exporting data to the D-Bus, in order to make tracking
|
||||||
|
# changes possible. Does everybody first invalidate its data before leaving the bus?
|
||||||
|
# And what about before taking one object away from the bus, instead of taking the
|
||||||
|
# whole service offline?
|
||||||
|
# They should! And after taking one value away, do we need to know that someone left
|
||||||
|
# the bus? Or we just keep that value in invalidated for ever? Result is that we can't
|
||||||
|
# see the difference anymore between an invalidated value and a value that was first on
|
||||||
|
# the bus and later not anymore. See comments above VeDbusItemImport as well.
|
||||||
|
# 9 there are probably more todos in the code below.
|
||||||
|
|
||||||
|
# Some thoughts with regards to the data types:
|
||||||
|
#
|
||||||
|
# Text from: http://dbus.freedesktop.org/doc/dbus-python/doc/tutorial.html#data-types
|
||||||
|
# ---
|
||||||
|
# Variants are represented by setting the variant_level keyword argument in the
|
||||||
|
# constructor of any D-Bus data type to a value greater than 0 (variant_level 1
|
||||||
|
# means a variant containing some other data type, variant_level 2 means a variant
|
||||||
|
# containing a variant containing some other data type, and so on). If a non-variant
|
||||||
|
# is passed as an argument but introspection indicates that a variant is expected,
|
||||||
|
# it'll automatically be wrapped in a variant.
|
||||||
|
# ---
|
||||||
|
#
|
||||||
|
# Also the different dbus datatypes, such as dbus.Int32, and dbus.UInt32 are a subclass
|
||||||
|
# of Python int. dbus.String is a subclass of Python standard class unicode, etcetera
|
||||||
|
#
|
||||||
|
# So all together that explains why we don't need to explicitly convert back and forth
|
||||||
|
# between the dbus datatypes and the standard python datatypes. Note that all datatypes
|
||||||
|
# in python are objects. Even an int is an object.
|
||||||
|
|
||||||
|
# The signature of a variant is 'v'.
|
||||||
|
|
||||||
|
# Export ourselves as a D-Bus service.
|
||||||
|
class VeDbusService(object):
|
||||||
|
def __init__(self, servicename, bus=None):
|
||||||
|
# dict containing the VeDbusItemExport objects, with their path as the key.
|
||||||
|
self._dbusobjects = {}
|
||||||
|
self._dbusnodes = {}
|
||||||
|
self._ratelimiters = []
|
||||||
|
self._dbusname = None
|
||||||
|
|
||||||
|
# dict containing the onchange callbacks, for each object. Object path is the key
|
||||||
|
self._onchangecallbacks = {}
|
||||||
|
|
||||||
|
# Connect to session bus whenever present, else use the system bus
|
||||||
|
self._dbusconn = bus or (dbus.SessionBus() if 'DBUS_SESSION_BUS_ADDRESS' in os.environ else dbus.SystemBus())
|
||||||
|
|
||||||
|
# make the dbus connection available to outside, could make this a true property instead, but ach..
|
||||||
|
self.dbusconn = self._dbusconn
|
||||||
|
|
||||||
|
# Register ourselves on the dbus, trigger an error if already in use (do_not_queue)
|
||||||
|
self._dbusname = dbus.service.BusName(servicename, self._dbusconn, do_not_queue=True)
|
||||||
|
|
||||||
|
# Add the root item that will return all items as a tree
|
||||||
|
self._dbusnodes['/'] = VeDbusRootExport(self._dbusconn, '/', self)
|
||||||
|
|
||||||
|
logging.info("registered ourselves on D-Bus as %s" % servicename)
|
||||||
|
|
||||||
|
# To force immediate deregistering of this dbus service and all its object paths, explicitly
|
||||||
|
# call __del__().
|
||||||
|
def __del__(self):
|
||||||
|
for node in list(self._dbusnodes.values()):
|
||||||
|
node.__del__()
|
||||||
|
self._dbusnodes.clear()
|
||||||
|
for item in list(self._dbusobjects.values()):
|
||||||
|
item.__del__()
|
||||||
|
self._dbusobjects.clear()
|
||||||
|
if self._dbusname:
|
||||||
|
self._dbusname.__del__() # Forces call to self._bus.release_name(self._name), see source code
|
||||||
|
self._dbusname = None
|
||||||
|
|
||||||
|
def get_name(self):
|
||||||
|
return self._dbusname.get_name()
|
||||||
|
|
||||||
|
# @param callbackonchange function that will be called when this value is changed. First parameter will
|
||||||
|
# be the path of the object, second the new value. This callback should return
|
||||||
|
# True to accept the change, False to reject it.
|
||||||
|
def add_path(self, path, value, description="", writeable=False,
|
||||||
|
onchangecallback=None, gettextcallback=None, valuetype=None, itemtype=None):
|
||||||
|
|
||||||
|
if onchangecallback is not None:
|
||||||
|
self._onchangecallbacks[path] = onchangecallback
|
||||||
|
|
||||||
|
itemtype = itemtype or VeDbusItemExport
|
||||||
|
item = itemtype(self._dbusconn, path, value, description, writeable,
|
||||||
|
self._value_changed, gettextcallback, deletecallback=self._item_deleted, valuetype=valuetype)
|
||||||
|
|
||||||
|
spl = path.split('/')
|
||||||
|
for i in range(2, len(spl)):
|
||||||
|
subPath = '/'.join(spl[:i])
|
||||||
|
if subPath not in self._dbusnodes and subPath not in self._dbusobjects:
|
||||||
|
self._dbusnodes[subPath] = VeDbusTreeExport(self._dbusconn, subPath, self)
|
||||||
|
self._dbusobjects[path] = item
|
||||||
|
logging.debug('added %s with start value %s. Writeable is %s' % (path, value, writeable))
|
||||||
|
|
||||||
|
# Add the mandatory paths, as per victron dbus api doc
|
||||||
|
def add_mandatory_paths(self, processname, processversion, connection,
|
||||||
|
deviceinstance, productid, productname, firmwareversion, hardwareversion, connected):
|
||||||
|
self.add_path('/Mgmt/ProcessName', processname)
|
||||||
|
self.add_path('/Mgmt/ProcessVersion', processversion)
|
||||||
|
self.add_path('/Mgmt/Connection', connection)
|
||||||
|
|
||||||
|
# Create rest of the mandatory objects
|
||||||
|
self.add_path('/DeviceInstance', deviceinstance)
|
||||||
|
self.add_path('/ProductId', productid)
|
||||||
|
self.add_path('/ProductName', productname)
|
||||||
|
self.add_path('/FirmwareVersion', firmwareversion)
|
||||||
|
self.add_path('/HardwareVersion', hardwareversion)
|
||||||
|
self.add_path('/Connected', connected)
|
||||||
|
|
||||||
|
# Callback function that is called from the VeDbusItemExport objects when a value changes. This function
|
||||||
|
# maps the change-request to the onchangecallback given to us for this specific path.
|
||||||
|
def _value_changed(self, path, newvalue):
|
||||||
|
if path not in self._onchangecallbacks:
|
||||||
|
return True
|
||||||
|
|
||||||
|
return self._onchangecallbacks[path](path, newvalue)
|
||||||
|
|
||||||
|
def _item_deleted(self, path):
|
||||||
|
self._dbusobjects.pop(path)
|
||||||
|
for np in list(self._dbusnodes.keys()):
|
||||||
|
if np != '/':
|
||||||
|
for ip in self._dbusobjects:
|
||||||
|
if ip.startswith(np + '/'):
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
self._dbusnodes[np].__del__()
|
||||||
|
self._dbusnodes.pop(np)
|
||||||
|
|
||||||
|
def __getitem__(self, path):
|
||||||
|
return self._dbusobjects[path].local_get_value()
|
||||||
|
|
||||||
|
def __setitem__(self, path, newvalue):
|
||||||
|
self._dbusobjects[path].local_set_value(newvalue)
|
||||||
|
|
||||||
|
def __delitem__(self, path):
|
||||||
|
self._dbusobjects[path].__del__() # Invalidates and then removes the object path
|
||||||
|
assert path not in self._dbusobjects
|
||||||
|
|
||||||
|
def __contains__(self, path):
|
||||||
|
return path in self._dbusobjects
|
||||||
|
|
||||||
|
def __enter__(self):
|
||||||
|
l = ServiceContext(self)
|
||||||
|
self._ratelimiters.append(l)
|
||||||
|
return l
|
||||||
|
|
||||||
|
def __exit__(self, *exc):
|
||||||
|
# pop off the top one and flush it. If with statements are nested
|
||||||
|
# then each exit flushes its own part.
|
||||||
|
if self._ratelimiters:
|
||||||
|
self._ratelimiters.pop().flush()
|
||||||
|
|
||||||
|
class ServiceContext(object):
|
||||||
|
def __init__(self, parent):
|
||||||
|
self.parent = parent
|
||||||
|
self.changes = {}
|
||||||
|
|
||||||
|
def __getitem__(self, path):
|
||||||
|
return self.parent[path]
|
||||||
|
|
||||||
|
def __setitem__(self, path, newvalue):
|
||||||
|
c = self.parent._dbusobjects[path]._local_set_value(newvalue)
|
||||||
|
if c is not None:
|
||||||
|
self.changes[path] = c
|
||||||
|
|
||||||
|
def flush(self):
|
||||||
|
if self.changes:
|
||||||
|
self.parent._dbusnodes['/'].ItemsChanged(self.changes)
|
||||||
|
|
||||||
|
class TrackerDict(defaultdict):
|
||||||
|
""" Same as defaultdict, but passes the key to default_factory. """
|
||||||
|
def __missing__(self, key):
|
||||||
|
self[key] = x = self.default_factory(key)
|
||||||
|
return x
|
||||||
|
|
||||||
|
class VeDbusRootTracker(object):
|
||||||
|
""" This tracks the root of a dbus path and listens for PropertiesChanged
|
||||||
|
signals. When a signal arrives, parse it and unpack the key/value changes
|
||||||
|
into traditional events, then pass it to the original eventCallback
|
||||||
|
method. """
|
||||||
|
def __init__(self, bus, serviceName):
|
||||||
|
self.importers = defaultdict(weakref.WeakSet)
|
||||||
|
self.serviceName = serviceName
|
||||||
|
self._match = bus.get_object(serviceName, '/', introspect=False).connect_to_signal(
|
||||||
|
"ItemsChanged", weak_functor(self._items_changed_handler))
|
||||||
|
|
||||||
|
def __del__(self):
|
||||||
|
self._match.remove()
|
||||||
|
self._match = None
|
||||||
|
|
||||||
|
def add(self, i):
|
||||||
|
self.importers[i.path].add(i)
|
||||||
|
|
||||||
|
def _items_changed_handler(self, items):
|
||||||
|
if not isinstance(items, dict):
|
||||||
|
return
|
||||||
|
|
||||||
|
for path, changes in items.items():
|
||||||
|
try:
|
||||||
|
v = changes['Value']
|
||||||
|
except KeyError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
try:
|
||||||
|
t = changes['Text']
|
||||||
|
except KeyError:
|
||||||
|
t = str(unwrap_dbus_value(v))
|
||||||
|
|
||||||
|
for i in self.importers.get(path, ()):
|
||||||
|
i._properties_changed_handler({'Value': v, 'Text': t})
|
||||||
|
|
||||||
|
"""
|
||||||
|
Importing basics:
|
||||||
|
- If when we power up, the D-Bus service does not exist, or it does exist and the path does not
|
||||||
|
yet exist, still subscribe to a signal: as soon as it comes online it will send a signal with its
|
||||||
|
initial value, which VeDbusItemImport will receive and use to update local cache. And, when set,
|
||||||
|
call the eventCallback.
|
||||||
|
- If when we power up, save it
|
||||||
|
- When using get_value, know that there is no difference between services (or object paths) that don't
|
||||||
|
exist and paths that are invalid (= empty array, see above). Both will return None. In case you do
|
||||||
|
really want to know ifa path exists or not, use the exists property.
|
||||||
|
- When a D-Bus service leaves the D-Bus, it will first invalidate all its values, and send signals
|
||||||
|
with that update, and only then leave the D-Bus. (or do we need to subscribe to the NameOwnerChanged-
|
||||||
|
signal!?!) To be discussed and make sure. Not really urgent, since all existing code that uses this
|
||||||
|
class already subscribes to the NameOwnerChanged signal, and subsequently removes instances of this
|
||||||
|
class.
|
||||||
|
|
||||||
|
Read when using this class:
|
||||||
|
Note that when a service leaves that D-Bus without invalidating all its exported objects first, for
|
||||||
|
example because it is killed, VeDbusItemImport doesn't have a clue. So when using VeDbusItemImport,
|
||||||
|
make sure to also subscribe to the NamerOwnerChanged signal on bus-level. Or just use dbusmonitor,
|
||||||
|
because that takes care of all of that for you.
|
||||||
|
"""
|
||||||
|
class VeDbusItemImport(object):
|
||||||
|
def __new__(cls, bus, serviceName, path, eventCallback=None, createsignal=True):
|
||||||
|
instance = object.__new__(cls)
|
||||||
|
|
||||||
|
# If signal tracking should be done, also add to root tracker
|
||||||
|
if createsignal:
|
||||||
|
if "_roots" not in cls.__dict__:
|
||||||
|
cls._roots = TrackerDict(lambda k: VeDbusRootTracker(bus, k))
|
||||||
|
|
||||||
|
return instance
|
||||||
|
|
||||||
|
## Constructor
|
||||||
|
# @param bus the bus-object (SESSION or SYSTEM).
|
||||||
|
# @param serviceName the dbus-service-name (string), for example 'com.victronenergy.battery.ttyO1'
|
||||||
|
# @param path the object-path, for example '/Dc/V'
|
||||||
|
# @param eventCallback function that you want to be called on a value change
|
||||||
|
# @param createSignal only set this to False if you use this function to one time read a value. When
|
||||||
|
# leaving it to True, make sure to also subscribe to the NameOwnerChanged signal
|
||||||
|
# elsewhere. See also note some 15 lines up.
|
||||||
|
def __init__(self, bus, serviceName, path, eventCallback=None, createsignal=True):
|
||||||
|
# TODO: is it necessary to store _serviceName and _path? Isn't it
|
||||||
|
# stored in the bus_getobjectsomewhere?
|
||||||
|
self._serviceName = serviceName
|
||||||
|
self._path = path
|
||||||
|
self._match = None
|
||||||
|
# TODO: _proxy is being used in settingsdevice.py, make a getter for that
|
||||||
|
self._proxy = bus.get_object(serviceName, path, introspect=False)
|
||||||
|
self.eventCallback = eventCallback
|
||||||
|
|
||||||
|
assert eventCallback is None or createsignal == True
|
||||||
|
if createsignal:
|
||||||
|
self._match = self._proxy.connect_to_signal(
|
||||||
|
"PropertiesChanged", weak_functor(self._properties_changed_handler))
|
||||||
|
self._roots[serviceName].add(self)
|
||||||
|
|
||||||
|
# store the current value in _cachedvalue. When it doesn't exists set _cachedvalue to
|
||||||
|
# None, same as when a value is invalid
|
||||||
|
self._cachedvalue = None
|
||||||
|
try:
|
||||||
|
v = self._proxy.GetValue()
|
||||||
|
except dbus.exceptions.DBusException:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
self._cachedvalue = unwrap_dbus_value(v)
|
||||||
|
|
||||||
|
def __del__(self):
|
||||||
|
if self._match is not None:
|
||||||
|
self._match.remove()
|
||||||
|
self._match = None
|
||||||
|
self._proxy = None
|
||||||
|
|
||||||
|
def _refreshcachedvalue(self):
|
||||||
|
self._cachedvalue = unwrap_dbus_value(self._proxy.GetValue())
|
||||||
|
|
||||||
|
## Returns the path as a string, for example '/AC/L1/V'
|
||||||
|
@property
|
||||||
|
def path(self):
|
||||||
|
return self._path
|
||||||
|
|
||||||
|
## Returns the dbus service name as a string, for example com.victronenergy.vebus.ttyO1
|
||||||
|
@property
|
||||||
|
def serviceName(self):
|
||||||
|
return self._serviceName
|
||||||
|
|
||||||
|
## Returns the value of the dbus-item.
|
||||||
|
# the type will be a dbus variant, for example dbus.Int32(0, variant_level=1)
|
||||||
|
# this is not a property to keep the name consistant with the com.victronenergy.busitem interface
|
||||||
|
# returns None when the property is invalid
|
||||||
|
def get_value(self):
|
||||||
|
return self._cachedvalue
|
||||||
|
|
||||||
|
## Writes a new value to the dbus-item
|
||||||
|
def set_value(self, newvalue):
|
||||||
|
r = self._proxy.SetValue(wrap_dbus_value(newvalue))
|
||||||
|
|
||||||
|
# instead of just saving the value, go to the dbus and get it. So we have the right type etc.
|
||||||
|
if r == 0:
|
||||||
|
self._refreshcachedvalue()
|
||||||
|
|
||||||
|
return r
|
||||||
|
|
||||||
|
## Resets the item to its default value
|
||||||
|
def set_default(self):
|
||||||
|
self._proxy.SetDefault()
|
||||||
|
self._refreshcachedvalue()
|
||||||
|
|
||||||
|
## Returns the text representation of the value.
|
||||||
|
# For example when the value is an enum/int GetText might return the string
|
||||||
|
# belonging to that enum value. Another example, for a voltage, GetValue
|
||||||
|
# would return a float, 12.0Volt, and GetText could return 12 VDC.
|
||||||
|
#
|
||||||
|
# Note that this depends on how the dbus-producer has implemented this.
|
||||||
|
def get_text(self):
|
||||||
|
return self._proxy.GetText()
|
||||||
|
|
||||||
|
## Returns true of object path exists, and false if it doesn't
|
||||||
|
@property
|
||||||
|
def exists(self):
|
||||||
|
# TODO: do some real check instead of this crazy thing.
|
||||||
|
r = False
|
||||||
|
try:
|
||||||
|
r = self._proxy.GetValue()
|
||||||
|
r = True
|
||||||
|
except dbus.exceptions.DBusException:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return r
|
||||||
|
|
||||||
|
## callback for the trigger-event.
|
||||||
|
# @param eventCallback the event-callback-function.
|
||||||
|
@property
|
||||||
|
def eventCallback(self):
|
||||||
|
return self._eventCallback
|
||||||
|
|
||||||
|
@eventCallback.setter
|
||||||
|
def eventCallback(self, eventCallback):
|
||||||
|
self._eventCallback = eventCallback
|
||||||
|
|
||||||
|
## Is called when the value of the imported bus-item changes.
|
||||||
|
# Stores the new value in our local cache, and calls the eventCallback, if set.
|
||||||
|
def _properties_changed_handler(self, changes):
|
||||||
|
if "Value" in changes:
|
||||||
|
changes['Value'] = unwrap_dbus_value(changes['Value'])
|
||||||
|
self._cachedvalue = changes['Value']
|
||||||
|
if self._eventCallback:
|
||||||
|
# The reason behind this try/except is to prevent errors silently ending up the an error
|
||||||
|
# handler in the dbus code.
|
||||||
|
try:
|
||||||
|
self._eventCallback(self._serviceName, self._path, changes)
|
||||||
|
except:
|
||||||
|
traceback.print_exc()
|
||||||
|
os._exit(1) # sys.exit() is not used, since that also throws an exception
|
||||||
|
|
||||||
|
|
||||||
|
class VeDbusTreeExport(dbus.service.Object):
|
||||||
|
def __init__(self, bus, objectPath, service):
|
||||||
|
dbus.service.Object.__init__(self, bus, objectPath)
|
||||||
|
self._service = service
|
||||||
|
logging.debug("VeDbusTreeExport %s has been created" % objectPath)
|
||||||
|
|
||||||
|
def __del__(self):
|
||||||
|
# self._get_path() will raise an exception when retrieved after the call to .remove_from_connection,
|
||||||
|
# so we need a copy.
|
||||||
|
path = self._get_path()
|
||||||
|
if path is None:
|
||||||
|
return
|
||||||
|
self.remove_from_connection()
|
||||||
|
logging.debug("VeDbusTreeExport %s has been removed" % path)
|
||||||
|
|
||||||
|
def _get_path(self):
|
||||||
|
if len(self._locations) == 0:
|
||||||
|
return None
|
||||||
|
return self._locations[0][1]
|
||||||
|
|
||||||
|
def _get_value_handler(self, path, get_text=False):
|
||||||
|
logging.debug("_get_value_handler called for %s" % path)
|
||||||
|
r = {}
|
||||||
|
px = path
|
||||||
|
if not px.endswith('/'):
|
||||||
|
px += '/'
|
||||||
|
for p, item in self._service._dbusobjects.items():
|
||||||
|
if p.startswith(px):
|
||||||
|
v = item.GetText() if get_text else wrap_dbus_value(item.local_get_value())
|
||||||
|
r[p[len(px):]] = v
|
||||||
|
logging.debug(r)
|
||||||
|
return r
|
||||||
|
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', out_signature='v')
|
||||||
|
def GetValue(self):
|
||||||
|
value = self._get_value_handler(self._get_path())
|
||||||
|
return dbus.Dictionary(value, signature=dbus.Signature('sv'), variant_level=1)
|
||||||
|
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', out_signature='v')
|
||||||
|
def GetText(self):
|
||||||
|
return self._get_value_handler(self._get_path(), True)
|
||||||
|
|
||||||
|
def local_get_value(self):
|
||||||
|
return self._get_value_handler(self.path)
|
||||||
|
|
||||||
|
class VeDbusRootExport(VeDbusTreeExport):
|
||||||
|
@dbus.service.signal('com.victronenergy.BusItem', signature='a{sa{sv}}')
|
||||||
|
def ItemsChanged(self, changes):
|
||||||
|
pass
|
||||||
|
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', out_signature='a{sa{sv}}')
|
||||||
|
def GetItems(self):
|
||||||
|
return {
|
||||||
|
path: {
|
||||||
|
'Value': wrap_dbus_value(item.local_get_value()),
|
||||||
|
'Text': item.GetText() }
|
||||||
|
for path, item in self._service._dbusobjects.items()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class VeDbusItemExport(dbus.service.Object):
|
||||||
|
## Constructor of VeDbusItemExport
|
||||||
|
#
|
||||||
|
# Use this object to export (publish), values on the dbus
|
||||||
|
# Creates the dbus-object under the given dbus-service-name.
|
||||||
|
# @param bus The dbus object.
|
||||||
|
# @param objectPath The dbus-object-path.
|
||||||
|
# @param value Value to initialize ourselves with, defaults to None which means Invalid
|
||||||
|
# @param description String containing a description. Can be called over the dbus with GetDescription()
|
||||||
|
# @param writeable what would this do!? :).
|
||||||
|
# @param callback Function that will be called when someone else changes the value of this VeBusItem
|
||||||
|
# over the dbus. First parameter passed to callback will be our path, second the new
|
||||||
|
# value. This callback should return True to accept the change, False to reject it.
|
||||||
|
def __init__(self, bus, objectPath, value=None, description=None, writeable=False,
|
||||||
|
onchangecallback=None, gettextcallback=None, deletecallback=None,
|
||||||
|
valuetype=None):
|
||||||
|
dbus.service.Object.__init__(self, bus, objectPath)
|
||||||
|
self._onchangecallback = onchangecallback
|
||||||
|
self._gettextcallback = gettextcallback
|
||||||
|
self._value = value
|
||||||
|
self._description = description
|
||||||
|
self._writeable = writeable
|
||||||
|
self._deletecallback = deletecallback
|
||||||
|
self._type = valuetype
|
||||||
|
|
||||||
|
# To force immediate deregistering of this dbus object, explicitly call __del__().
|
||||||
|
def __del__(self):
|
||||||
|
# self._get_path() will raise an exception when retrieved after the
|
||||||
|
# call to .remove_from_connection, so we need a copy.
|
||||||
|
path = self._get_path()
|
||||||
|
if path == None:
|
||||||
|
return
|
||||||
|
if self._deletecallback is not None:
|
||||||
|
self._deletecallback(path)
|
||||||
|
self.remove_from_connection()
|
||||||
|
logging.debug("VeDbusItemExport %s has been removed" % path)
|
||||||
|
|
||||||
|
def _get_path(self):
|
||||||
|
if len(self._locations) == 0:
|
||||||
|
return None
|
||||||
|
return self._locations[0][1]
|
||||||
|
|
||||||
|
## Sets the value. And in case the value is different from what it was, a signal
|
||||||
|
# will be emitted to the dbus. This function is to be used in the python code that
|
||||||
|
# is using this class to export values to the dbus.
|
||||||
|
# set value to None to indicate that it is Invalid
|
||||||
|
def local_set_value(self, newvalue):
|
||||||
|
changes = self._local_set_value(newvalue)
|
||||||
|
if changes is not None:
|
||||||
|
self.PropertiesChanged(changes)
|
||||||
|
|
||||||
|
def _local_set_value(self, newvalue):
|
||||||
|
if self._value == newvalue:
|
||||||
|
return None
|
||||||
|
|
||||||
|
self._value = newvalue
|
||||||
|
return {
|
||||||
|
'Value': wrap_dbus_value(newvalue),
|
||||||
|
'Text': self.GetText()
|
||||||
|
}
|
||||||
|
|
||||||
|
def local_get_value(self):
|
||||||
|
return self._value
|
||||||
|
|
||||||
|
# ==== ALL FUNCTIONS BELOW THIS LINE WILL BE CALLED BY OTHER PROCESSES OVER THE DBUS ====
|
||||||
|
|
||||||
|
## Dbus exported method SetValue
|
||||||
|
# Function is called over the D-Bus by other process. It will first check (via callback) if new
|
||||||
|
# value is accepted. And it is, stores it and emits a changed-signal.
|
||||||
|
# @param value The new value.
|
||||||
|
# @return completion-code When successful a 0 is return, and when not a -1 is returned.
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', in_signature='v', out_signature='i')
|
||||||
|
def SetValue(self, newvalue):
|
||||||
|
if not self._writeable:
|
||||||
|
return 1 # NOT OK
|
||||||
|
|
||||||
|
newvalue = unwrap_dbus_value(newvalue)
|
||||||
|
|
||||||
|
# If value type is enforced, cast it. If the type can be coerced
|
||||||
|
# python will do it for us. This allows ints to become floats,
|
||||||
|
# or bools to become ints. Additionally also allow None, so that
|
||||||
|
# a path may be invalidated.
|
||||||
|
if self._type is not None and newvalue is not None:
|
||||||
|
try:
|
||||||
|
newvalue = self._type(newvalue)
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
return 1 # NOT OK
|
||||||
|
|
||||||
|
if newvalue == self._value:
|
||||||
|
return 0 # OK
|
||||||
|
|
||||||
|
# call the callback given to us, and check if new value is OK.
|
||||||
|
if (self._onchangecallback is None or
|
||||||
|
(self._onchangecallback is not None and self._onchangecallback(self.__dbus_object_path__, newvalue))):
|
||||||
|
|
||||||
|
self.local_set_value(newvalue)
|
||||||
|
return 0 # OK
|
||||||
|
|
||||||
|
return 2 # NOT OK
|
||||||
|
|
||||||
|
## Dbus exported method GetDescription
|
||||||
|
#
|
||||||
|
# Returns the a description.
|
||||||
|
# @param language A language code (e.g. ISO 639-1 en-US).
|
||||||
|
# @param length Lenght of the language string.
|
||||||
|
# @return description
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', in_signature='si', out_signature='s')
|
||||||
|
def GetDescription(self, language, length):
|
||||||
|
return self._description if self._description is not None else 'No description given'
|
||||||
|
|
||||||
|
## Dbus exported method GetValue
|
||||||
|
# Returns the value.
|
||||||
|
# @return the value when valid, and otherwise an empty array
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', out_signature='v')
|
||||||
|
def GetValue(self):
|
||||||
|
return wrap_dbus_value(self._value)
|
||||||
|
|
||||||
|
## Dbus exported method GetText
|
||||||
|
# Returns the value as string of the dbus-object-path.
|
||||||
|
# @return text A text-value. '---' when local value is invalid
|
||||||
|
@dbus.service.method('com.victronenergy.BusItem', out_signature='s')
|
||||||
|
def GetText(self):
|
||||||
|
if self._value is None:
|
||||||
|
return '---'
|
||||||
|
|
||||||
|
# Default conversion from dbus.Byte will get you a character (so 'T' instead of '84'), so we
|
||||||
|
# have to convert to int first. Note that if a dbus.Byte turns up here, it must have come from
|
||||||
|
# the application itself, as all data from the D-Bus should have been unwrapped by now.
|
||||||
|
if self._gettextcallback is None and type(self._value) == dbus.Byte:
|
||||||
|
return str(int(self._value))
|
||||||
|
|
||||||
|
if self._gettextcallback is None and self.__dbus_object_path__ == '/ProductId':
|
||||||
|
return "0x%X" % self._value
|
||||||
|
|
||||||
|
if self._gettextcallback is None:
|
||||||
|
return str(self._value)
|
||||||
|
|
||||||
|
return self._gettextcallback(self.__dbus_object_path__, self._value)
|
||||||
|
|
||||||
|
## The signal that indicates that the value has changed.
|
||||||
|
# Other processes connected to this BusItem object will have subscribed to the
|
||||||
|
# event when they want to track our state.
|
||||||
|
@dbus.service.signal('com.victronenergy.BusItem', signature='a{sv}')
|
||||||
|
def PropertiesChanged(self, changes):
|
||||||
|
pass
|
||||||
|
|
||||||
|
## This class behaves like a regular reference to a class method (eg. self.foo), but keeps a weak reference
|
||||||
|
## to the object which method is to be called.
|
||||||
|
## Use this object to break circular references.
|
||||||
|
class weak_functor:
|
||||||
|
def __init__(self, f):
|
||||||
|
self._r = weakref.ref(f.__self__)
|
||||||
|
self._f = weakref.ref(f.__func__)
|
||||||
|
|
||||||
|
def __call__(self, *args, **kargs):
|
||||||
|
r = self._r()
|
||||||
|
f = self._f()
|
||||||
|
if r == None or f == None:
|
||||||
|
return
|
||||||
|
f(r, *args, **kargs)
|
|
@ -0,0 +1,7 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
. /opt/victronenergy/serial-starter/run-service.sh
|
||||||
|
|
||||||
|
app=/opt/victronenergy/dbus-fzsonick-48tl/dbus-fzsonick-48tl.py
|
||||||
|
args="$tty"
|
||||||
|
start $args
|
Loading…
Reference in New Issue