def _read_one_interface_xml(p_interface_element):
l_interface_obj = NodeInterfaceData()
XmlConfigTools.read_base_UUID_object_xml(l_interface_obj, p_interface_element)
l_interface_obj.MacAddress = PutGetXML.get_text_from_xml(p_interface_element, 'MacAddress')
l_interface_obj.V4Address = PutGetXML.get_text_from_xml(p_interface_element, 'IPv4Address')
l_interface_obj.V6Address = PutGetXML.get_text_from_xml(p_interface_element, 'IPv6Address')
l_interface_obj.NodeInterfaceType = PutGetXML.get_text_from_xml(p_interface_element, 'InterfaceType')
return l_interface_obj
def _read_one_login(p_xml):
"""
@param p_xml: is the element of one login
"""
l_obj = LoginData()
XmlConfigTools.read_base_UUID_object_xml(l_obj, p_xml)
l_obj.LoginFullName = PutGetXML.get_text_from_xml(p_xml, 'FullName')
l_obj.LoginPasswordCurrent = PutGetXML.get_text_from_xml(p_xml, 'Password')
l_obj.LoginRole = PutGetXML.get_text_from_xml(p_xml, 'Role')
LOG.info('Loaded login "{}"'.format(l_obj.LoginFullName))
return l_obj
def _read_house_base(p_pyhouse_obj):
l_obj = p_pyhouse_obj.House
l_xml = p_pyhouse_obj.Xml.XmlRoot.find('HouseDivision')
if l_xml is None:
l_obj.Name = 'Default Name'
l_obj.Key = 0
l_obj.Active = True
return l_obj
XmlConfigTools.read_base_UUID_object_xml(l_obj, l_xml)
Xml._add_uuid(p_pyhouse_obj, l_obj)
return l_obj
def _read_one_login(p_xml):
"""
@param p_xml: is the element of one login
"""
l_obj = LoginData()
XmlConfigTools.read_base_UUID_object_xml(l_obj, p_xml)
l_obj.LoginFullName = PutGetXML.get_text_from_xml(p_xml, 'FullName')
l_obj.LoginPasswordCurrent = PutGetXML.get_text_from_xml(
p_xml, 'Password')
l_obj.LoginRole = PutGetXML.get_text_from_xml(p_xml, 'Role')
LOG.info('Loaded login "{}"'.format(l_obj.LoginFullName))
return l_obj
def _read_device(p_xml):
l_device = SamsungDeviceData()
XmlConfigTools.read_base_UUID_object_xml(l_device, p_xml)
l_device.Installed = PutGetXML.get_text_from_xml(p_xml, 'Installed')
l_device.IPv4 = PutGetXML.get_ip_from_xml(p_xml, 'IPv4')
# l_device.Model = PutGetXML.get_text_from_xml(p_xml, 'Model')
l_device.Port = PutGetXML.get_int_from_xml(p_xml, 'Port', 55000)
l_device.RoomName = PutGetXML.get_text_from_xml(p_xml, 'RoomName')
l_device.RoomUUID = PutGetXML.get_uuid_from_xml(p_xml, 'RoomUUID')
l_device.Type = PutGetXML.get_text_from_xml(p_xml, 'Type')
l_device.Volume = PutGetXML.get_int_from_xml(p_xml, 'Volume')
return l_device
def read_one_room(p_room_element):
l_room_obj = RoomData()
try:
XmlConfigTools.read_base_UUID_object_xml(l_room_obj, p_room_element)
l_room_obj.Comment = PutGetXML.get_text_from_xml(p_room_element, 'Comment')
l_room_obj.Corner = PutGetXML.get_coords_from_xml(p_room_element, 'Corner')
l_room_obj.Floor = PutGetXML.get_text_from_xml(p_room_element, 'Floor', '1')
l_room_obj.LastUpdate = PutGetXML.get_date_time_from_xml(p_room_element, 'LastUpdate')
l_room_obj.Size = PutGetXML.get_coords_from_xml(p_room_element, 'Size')
l_room_obj.RoomType = PutGetXML.get_text_from_xml(p_room_element, 'RoomType')
except:
LOG.warn('Incomplete data for room {}'.format(l_room_obj.Name))
return l_room_obj
def _read_device(p_xml):
""" Read an entire <Device> section of XML and fill in the PanasonicDeviceData Object
@return: a completed PanasonicDeviceData object
"""
l_device = PanasonicDeviceData()
XmlConfigTools.read_base_UUID_object_xml(l_device, p_xml)
l_device.IPv4 = PutGetXML.get_ip_from_xml(p_xml, 'IPv4')
l_device.Port = PutGetXML.get_int_from_xml(p_xml, 'Port')
l_device.RoomName = PutGetXML.get_text_from_xml(p_xml, 'RoomName')
l_device.RoomUUID = PutGetXML.get_uuid_from_xml(p_xml, 'RoomUUID')
l_device.Type = PutGetXML.get_text_from_xml(p_xml, 'Type')
l_device.Volume = PutGetXML.get_int_from_xml(p_xml, 'Volume')
return l_device
def _read_device(p_xml):
""" Read an entire <Device> section of XML and fill in the OnkyoDeviceData Object
@return: a completed OnkyoDeviceData object
"""
l_device = OnkyoDeviceData()
XmlConfigTools.read_base_UUID_object_xml(l_device, p_xml)
l_device.IPv4 = PutGetXML.get_ip_from_xml(p_xml, 'IPv4')
l_device.Port = PutGetXML.get_int_from_xml(p_xml, 'Port')
l_device.RoomName = PutGetXML.get_text_from_xml(p_xml, 'RoomName')
l_device.RoomUUID = PutGetXML.get_uuid_from_xml(p_xml, 'RoomUUID')
l_device.Type = PutGetXML.get_text_from_xml(p_xml, 'Type')
l_device.Volume = PutGetXML.get_int_from_xml(p_xml, 'Volume')
return l_device
def _read_one_base_schedule(p_schedule_element):
"""Extract schedule information from a Base schedule xml element.
ScheduleBaseData()
"""
l_obj = ScheduleBaseData()
XmlConfigTools.read_base_UUID_object_xml(l_obj, p_schedule_element)
l_obj.DOW = PutGetXML.get_int_from_xml(p_schedule_element, 'DayOfWeek', '127')
l_obj.ScheduleMode = PutGetXML.get_text_from_xml(p_schedule_element, 'ScheduleMode', 'Default Mode')
l_obj.ScheduleType = PutGetXML.get_text_from_xml(p_schedule_element, 'ScheduleType')
l_obj.Time = PutGetXML.get_text_from_xml(p_schedule_element, 'Time')
# if l_obj.ScheduleType == 'LightingDevice':
# l_obj.ScheduleType = 'Lighting'
return l_obj
def write_house_xml(p_pyhouse_obj):
"""Replace the data in the 'Houses' section with the current data.
"""
l_house_xml = XmlConfigTools.write_base_UUID_object_xml('HouseDivision', p_pyhouse_obj.House)
l_house_xml.append(locationXML.write_location_xml(p_pyhouse_obj.House.Location))
l_house_xml.append(roomsXML.write_rooms_xml(p_pyhouse_obj.House.Rooms))
return l_house_xml
def setUp(self):
SetupMixin.setUp(self, ET.fromstring(XML_LONG))
self.m_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj, 'HouseDivision/EntertainmentSection')
self.m_entertainment_obj = EntertainmentInformation()
self.m_pyhouse_obj.House.Entertainment = EntertainmentInformation(
) # Clear before loading
def setUp(self):
SetupMixin.setUp(self, ET.fromstring(XML_LONG))
self.m_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj, 'HouseDivision/EntertainmentSection')
self.m_entertain = entertainmentXML().read_entertainment_all(
self.m_pyhouse_obj)
self.m_pyhouse_obj.House.Entertainment = self.m_entertain
def _read_device(p_entry_xml):
"""
@param p_entry_xml: Element <Device> within <PandoraSection>
@return: a PandoraDeviceData object
"""
l_obj = PandoraDeviceData()
XmlConfigTools.read_base_object_xml(l_obj, p_entry_xml)
l_obj.Host = PutGetXML.get_ip_from_xml(p_entry_xml, 'Host')
l_obj.ConnectionFamily = PutGetXML.get_text_from_xml(p_entry_xml, 'ConnectionFamily')
l_obj.ConnectionName = PutGetXML.get_text_from_xml(p_entry_xml, 'ConnectionName').lower()
l_obj.InputName = PutGetXML.get_text_from_xml(p_entry_xml, 'InputName')
l_obj.InputCode = PutGetXML.get_text_from_xml(p_entry_xml, 'InputCode')
l_obj.MaxPlayTime = PutGetXML.get_int_from_xml(p_entry_xml, 'MaxPlayTime')
l_obj.Type = PutGetXML.get_text_from_xml(p_entry_xml, 'Type')
l_obj.Volume = PutGetXML.get_int_from_xml(p_entry_xml, 'Volume')
return l_obj
def read_panasonic_section_xml(p_pyhouse_obj):
""" Get the entire PanasonicDeviceData object from the xml.
"""
# Clear out the data sections
l_xml = XmlConfigTools.find_xml_section(
p_pyhouse_obj,
'HouseDivision/EntertainmentSection/PanasonicSection')
l_entry_obj = p_pyhouse_obj.House.Entertainment.Plugins[SECTION]
l_entry_obj.Name = SECTION
l_device_obj = PanasonicDeviceData()
l_count = 0
if l_xml is None:
l_entry_obj.Name = 'Did not find xml section '
return l_entry_obj
try:
l_entry_obj.Type = PutGetXML.get_text_from_xml(l_xml, 'Type')
for l_device_xml in l_xml.iterfind('Device'):
l_device_obj = XML._read_device(l_device_xml)
l_device_obj.Key = l_count
l_entry_obj.Devices[l_count] = l_device_obj
l_entry_obj.DeviceCount += 1
LOG.info('Loaded Panasonic Device {}'.format(l_entry_obj.Name))
l_count += 1
except AttributeError as e_err:
LOG.error(
'ERROR if getting Panasonic Device Data - {}'.format(e_err))
if l_count > 0:
l_entry_obj.Active = True
LOG.info('Loaded {} Panasonic Devices.'.format(l_count))
return l_entry_obj
def read_pandora_section_xml(p_pyhouse_obj):
"""
This has to:
Fill in an entry in Entertainment Plugins
@param p_pyhouse_obj: containing an XML Element for the <PandoraSection>
@return: a EntertainmentPluginData object filled in.
"""
l_plugin_obj = p_pyhouse_obj.House.Entertainment.Plugins[SECTION]
l_plugin_obj.Name = SECTION
l_xml = XmlConfigTools.find_section(p_pyhouse_obj, 'HouseDivision/EntertainmentSection/PandoraSection')
if l_xml is None:
return l_plugin_obj
l_count = 0
try:
l_plugin_obj.Active = PutGetXML.get_bool_from_xml(l_xml, 'Active')
l_plugin_obj.Type = PutGetXML.get_text_from_xml(l_xml, 'Type')
for l_device_xml in l_xml.iterfind('Device'):
l_device_obj = XML._read_device(l_device_xml)
l_device_obj.Key = l_count
l_plugin_obj.Devices[l_count] = l_device_obj
LOG.info('Loaded {} Device {}'.format(SECTION, l_plugin_obj.Name))
l_count += 1
l_plugin_obj.Count = l_count
except AttributeError as e_err:
LOG.error('ERROR if getting {} Device Data - {}'.format(SECTION, e_err))
p_pyhouse_obj.House.Entertainment.Plugins[SECTION] = l_plugin_obj
LOG.info('Loaded {} {} Devices.'.format(l_count, SECTION))
return l_plugin_obj
def read_onkyo_section_xml(p_pyhouse_obj):
""" Get the entire OnkyoDeviceData object from the xml.
"""
# Clear out the data sections
l_xml = XmlConfigTools.find_section(p_pyhouse_obj, 'HouseDivision/EntertainmentSection/OnkyoSection')
l_entry_obj = p_pyhouse_obj.House.Entertainment.Plugins[SECTION]
l_entry_obj.Name = SECTION
l_device_obj = OnkyoDeviceData()
l_count = 0
if l_xml is None:
l_entry_obj.Name = 'Did not find xml section '
return l_entry_obj
try:
l_entry_obj.Type = PutGetXML.get_text_from_xml(l_xml, 'Type')
for l_device_xml in l_xml.iterfind('Device'):
l_device_obj = XML._read_device(l_device_xml)
l_device_obj.Key = l_count
l_entry_obj.Devices[l_count] = l_device_obj
l_entry_obj.Count += 1
LOG.info('Loaded Onkyo Device {}'.format(l_entry_obj.Name))
l_count += 1
except AttributeError as e_err:
LOG.error('ERROR if getting Onkyo Device Data - {}'.format(e_err))
if l_count > 0:
l_entry_obj.Active = True
LOG.info('Loaded {} Onkyo Devices.'.format(l_count))
return l_entry_obj
def test_02_OneDevice0(self):
""" Test that _create_module_refs is functional
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/OnkyoSection')
l_xml = l_xml.findall('Device')[0]
l_device = EntertainmentDeviceInformation()
# print(PrettyFormatAny.form(l_xml, 'C1-02-A - Onkyo XML'))
l_ret = entertainmentXML().read_entertainment_device(l_xml, l_device)
# print(PrettyFormatAny.form(l_ret, 'C1-02-B - Onkyo Device'))
self.assertEqual(l_ret.Name, TESTING_ONKYO_DEVICE_NAME_0)
self.assertEqual(str(l_ret.Active), TESTING_ONKYO_DEVICE_ACTIVE_0)
self.assertEqual(str(l_ret.Key), TESTING_ONKYO_DEVICE_KEY_0)
self.assertEqual(str(l_ret.UUID), TESTING_ONKYO_DEVICE_UUID_0)
self.assertEqual(l_ret.Comment, TESTING_ONKYO_DEVICE_COMMENT_0)
self.assertEqual(l_ret.CommandSet, TESTING_ONKYO_DEVICE_COMMAND_SET_0)
self.assertEqual(l_ret.Host, TESTING_ONKYO_DEVICE_HOST_0)
self.assertEqual(convert.long_to_str(l_ret.IPv4),
TESTING_ONKYO_DEVICE_IPV4_0)
self.assertEqual(
convert.long_to_str(l_ret.IPv6).lower(),
TESTING_ONKYO_DEVICE_IPV6_0.lower())
self.assertEqual(l_ret.Model, TESTING_ONKYO_DEVICE_MODEL_0)
self.assertEqual(str(l_ret.Port), TESTING_ONKYO_DEVICE_PORT_0)
self.assertEqual(l_ret.RoomName, TESTING_ONKYO_DEVICE_ROOM_NAME_0)
self.assertEqual(l_ret.RoomUUID, TESTING_ONKYO_DEVICE_ROOM_UUID_0)
self.assertEqual(l_ret.Type, TESTING_ONKYO_DEVICE_TYPE_0)
self.assertEqual(str(l_ret.Volume), TESTING_ONKYO_DEVICE_VOLUME_0)
def read_base_device_object_xml(p_pyhouse_obj, p_obj, p_xml):
"""
Get the BaseUUIDObject entries from the XML element.
@param p_obj: is the object we wish to populate with data
@param p_xml: is the element we will extract data from (including children).
"""
XmlConfigTools.read_base_UUID_object_xml(p_obj, p_xml)
try:
p_obj.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
p_obj.DeviceFamily = PutGetXML.get_text_from_xml(p_xml, 'DeviceFamily')
p_obj.DeviceType = PutGetXML.get_int_from_xml(p_xml, 'DeviceType')
p_obj.DeviceSubType = PutGetXML.get_int_from_xml(p_xml, 'DeviceSubType')
utils.read_room_reference_xml(p_obj, p_xml)
except Exception as e_err:
LOG.error('ERROR in xml_tools.read_base_obj_xml() - {}'.format(e_err))
return p_obj
def _write_one_interface_xml(p_interface_obj):
l_entry = XmlConfigTools.write_base_UUID_object_xml('Interface', p_interface_obj)
PutGetXML.put_text_element(l_entry, 'MacAddress', p_interface_obj.MacAddress)
PutGetXML.put_text_element(l_entry, 'IPv4Address', p_interface_obj.V4Address)
PutGetXML.put_text_element(l_entry, 'IPv6Address', p_interface_obj.V6Address)
PutGetXML.put_text_element(l_entry, 'InterfaceType', p_interface_obj.NodeInterfaceType)
return l_entry
def _read_one_zone(p_xml):
"""
@param p_xml: XML information for one Zone.
@return: an IrrigationZone object filled in with data from the XML passed in
"""
l_obj = IrrigationZoneData()
XmlConfigTools.read_base_object_xml(l_obj, p_xml) # Name, Key, Active
# l_obj.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
l_obj.Duration = PutGetXML.get_time_from_xml(p_xml, 'Duration')
l_obj.EmitterCount = PutGetXML.get_int_from_xml(p_xml, 'EmitterCount', 0)
l_obj.EmitterType = PutGetXML.get_text_from_xml(p_xml, 'EmitterType')
l_obj.Next = PutGetXML.get_int_from_xml(p_xml, 'NextZone', 0)
l_obj.Previous = PutGetXML.get_int_from_xml(p_xml, 'PrevZone', 0)
l_obj.Rate = PutGetXML.get_float_from_xml(p_xml, 'Rate', 0.0)
l_obj.StartTime = PutGetXML.get_time_from_xml(p_xml, 'StartTime')
# Expand with much more control data
return l_obj
def _read_one_zone(p_xml):
"""
@param p_xml: XML information for one Zone.
@return: an IrrigationZone object filled in with data from the XML passed in
"""
l_obj = IrrigationZoneData()
XmlConfigTools.read_base_object_xml(l_obj, p_xml) # Name, Key, Active
l_obj.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
l_obj.Duration = PutGetXML.get_time_from_xml(p_xml, 'Duration')
l_obj.EmitterCount = PutGetXML.get_int_from_xml(p_xml, 'EmitterCount', 0)
l_obj.EmitterType = PutGetXML.get_text_from_xml(p_xml, 'EmitterType')
l_obj.Next = PutGetXML.get_int_from_xml(p_xml, 'NextZone', 0)
l_obj.Previous = PutGetXML.get_int_from_xml(p_xml, 'PrevZone', 0)
l_obj.Rate = PutGetXML.get_float_from_xml(p_xml, 'Rate', 0.0)
l_obj.StartTime = PutGetXML.get_time_from_xml(p_xml, 'StartTime')
# Expand with much more control data
return l_obj
def _write_one_node_xml(p_node_obj):
l_entry = XmlConfigTools.write_base_UUID_object_xml(NODE_ATTR, p_node_obj)
PutGetXML.put_text_element(l_entry, 'ConnectionAddressV4', p_node_obj.ConnectionAddr_IPv4)
PutGetXML.put_text_element(l_entry, 'ConnectionAddressV6', p_node_obj.ConnectionAddr_IPv6)
PutGetXML.put_int_element(l_entry, 'NodeRole', p_node_obj.NodeRole)
PutGetXML.put_date_time_element(l_entry, 'LastUpdate', p_node_obj.LastUpdate)
l_entry.append(Xml._write_interfaces_xml(p_node_obj.NodeInterfaces))
return l_entry
def _write_device(p_obj):
l_xml = XmlConfigTools.write_base_UUID_object_xml('Device', p_obj)
PutGetXML.put_ip_element(l_xml, 'IPv4', p_obj.IPv4)
PutGetXML.put_int_element(l_xml, 'Port', p_obj.Port)
PutGetXML.put_text_element(l_xml, 'RoomName', p_obj.RoomName)
PutGetXML.put_text_element(l_xml, 'RoomUUID', p_obj.RoomUUID)
PutGetXML.put_text_element(l_xml, 'Type', p_obj.Type)
PutGetXML.put_text_element(l_xml, 'Volume', p_obj.Volume)
return l_xml
def _write_one_login(p_obj):
"""
@param p_obj: is one login object
"""
l_xml = XmlConfigTools.write_base_UUID_object_xml('Login', p_obj)
PutGetXML().put_text_element(l_xml, 'FullName', p_obj.LoginFullName)
PutGetXML().put_text_element(l_xml, 'Password', p_obj.LoginPasswordCurrent)
PutGetXML().put_text_element(l_xml, 'Role', p_obj.LoginRole)
return l_xml
def _write_one_base_schedule(p_schedule_obj):
"""
"""
l_entry = XmlConfigTools.write_base_UUID_object_xml(SCHEDULE_ATTR, p_schedule_obj)
PutGetXML.put_int_element(l_entry, 'DayOfWeek', int(p_schedule_obj.DOW))
PutGetXML.put_text_element(l_entry, 'ScheduleMode', p_schedule_obj.ScheduleMode)
PutGetXML.put_text_element(l_entry, 'ScheduleType', p_schedule_obj.ScheduleType)
PutGetXML.put_text_element(l_entry, 'Time', p_schedule_obj.Time)
return l_entry
def write_one_room(p_room_object):
l_entry = XmlConfigTools.write_base_UUID_object_xml('Room', p_room_object)
PutGetXML.put_text_element(l_entry, 'Comment', p_room_object.Comment)
PutGetXML.put_coords_element(l_entry, 'Corner', p_room_object.Corner)
PutGetXML.put_text_element(l_entry, 'Floor', p_room_object.Floor)
PutGetXML.put_date_time_element(l_entry, 'LastUpdate', p_room_object.LastUpdate)
PutGetXML.put_coords_element(l_entry, 'Size', p_room_object.Size)
PutGetXML.put_text_element(l_entry, 'RoomType', p_room_object.RoomType)
return l_entry
def _write_device(p_obj):
l_xml = XmlConfigTools.write_base_UUID_object_xml('Device', p_obj)
PutGetXML.put_ip_element(l_xml, 'IPv4', p_obj.IPv4)
PutGetXML.put_int_element(l_xml, 'Port', p_obj.Port)
PutGetXML.put_text_element(l_xml, 'RoomName', p_obj.RoomName)
PutGetXML.put_text_element(l_xml, 'RoomUUID', p_obj.RoomUUID)
PutGetXML.put_text_element(l_xml, 'Type', p_obj.Type)
PutGetXML.put_text_element(l_xml, 'Volume', p_obj.Volume)
return l_xml
def _write_one_login(p_obj):
"""
@param p_obj: is one login object
"""
l_xml = XmlConfigTools.write_base_UUID_object_xml('Login', p_obj)
PutGetXML().put_text_element(l_xml, 'FullName', p_obj.LoginFullName)
PutGetXML().put_text_element(l_xml, 'Password',
p_obj.LoginPasswordCurrent)
PutGetXML().put_text_element(l_xml, 'Role', p_obj.LoginRole)
return l_xml
def _write_one_system(p_obj):
"""
@param p_obj: is one irrigation system object.
@return: the XML for one complete IrrigationSystem
"""
l_xml = XmlConfigTools.write_base_UUID_object_xml('IrrigationSystem', p_obj)
# PutGetXML.put_text_element(l_xml, 'Comment', p_obj.Comment)
for l_obj in p_obj.Zones.values():
l_zone = Xml._write_one_zone(l_obj)
l_xml.append(l_zone)
return l_xml
def _write_one_system(p_obj):
"""
@param p_obj: is one irrigation system object.
@return: the XML for one complete IrrigationSystem
"""
l_xml = XmlConfigTools.write_base_UUID_object_xml('IrrigationSystem', p_obj)
PutGetXML.put_text_element(l_xml, 'Comment', p_obj.Comment)
for l_obj in p_obj.Zones.values():
l_zone = Xml._write_one_zone(l_obj)
l_xml.append(l_zone)
return l_xml
def test_01_Setup(self):
"""
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/PandoraSection')
# print(PrettyFormatAny.form(l_xml, 'C2-01-A - Entertainment XML'))
self.assertEqual(l_xml.tag, TESTING_PANDORA_SECTION)
# print(PrettyFormatAny.form(self.m_pyhouse_obj.House.Entertainment, 'C2-01-B - Entertainment'))
self.assertEqual(self.m_entertainment_obj.Active, False)
self.assertEqual(self.m_entertainment_obj.PluginCount, 0)
self.assertEqual(self.m_entertainment_obj.Plugins, {})
def _read_one_irrigation_system(p_xml):
"""
May contain zero or more zones.
In general each zone is controlled by a solenoid controlled valve.
"""
l_sys = IrrigationSystemData()
l_count = 0
XmlConfigTools.read_base_UUID_object_xml(l_sys, p_xml)
try:
# l_sys.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
l_sys.FirstZone = PutGetXML.get_int_from_xml(p_xml, 'FirstZone')
l_sys.UsesMasterValve = PutGetXML.get_bool_from_xml(p_xml, 'MasterValve')
l_sys.UsesPumpStartRelay = PutGetXML.get_bool_from_xml(p_xml, 'PumpRelay')
l_sys.Type = PutGetXML.get_text_from_xml(p_xml, 'Type')
for l_zone in p_xml.iterfind(ZONE):
l_obj = Xml._read_one_zone(l_zone)
l_sys.Zones[l_count] = l_obj
l_count += 1
except AttributeError as e_err:
LOG.error('Zone: {}'.format(e_err))
return l_sys
def read_base_device_object_xml(p_obj, p_xml):
"""
Get the BaseUUIDObject entries from the XML element.
Adds: Device Info, Room Info.
@param p_obj: is the object we wish to populate with data
@param p_xml: is the element we will extract data from (including children).
"""
XmlConfigTools.read_base_UUID_object_xml(p_obj, p_xml)
try:
# p_obj.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
p_obj.DeviceFamily = PutGetXML.get_text_from_xml(
p_xml, 'DeviceFamily')
p_obj.DeviceType = PutGetXML.get_text_from_xml(p_xml, 'DeviceType')
p_obj.DeviceSubType = PutGetXML.get_text_from_xml(
p_xml, 'DeviceSubType')
utils.read_room_reference_xml(p_obj, p_xml)
except Exception as e_err:
LOG.error(
'ERROR in xml_tools.read_base_obj_xml() - {}'.format(e_err))
return p_obj
def read_all_pools_xml(p_pyhouse_obj):
l_dict = {}
l_count = 0
l_pools_sect = XmlConfigTools.find_xml_section(
p_pyhouse_obj, 'HouseDivision/PoolSection')
if l_pools_sect != None:
for l_pool in l_pools_sect.iterfind('Pool'):
l_one = Xml._read_one_pool(l_pool)
l_dict[l_count] = l_one
l_count += 1
p_pyhouse_obj.House.Pools = l_dict
return l_dict
def _read_one_irrigation_system(p_xml):
"""
May contain zero or more zones.
In general each zone is controlled by a solenoid controlled valve.
"""
l_sys = IrrigationSystemData()
l_count = 0
XmlConfigTools.read_base_UUID_object_xml(l_sys, p_xml)
try:
l_sys.Comment = PutGetXML.get_text_from_xml(p_xml, 'Comment')
l_sys.FirstZone = PutGetXML.get_int_from_xml(p_xml, 'FirstZone')
l_sys.UsesMasterValve = PutGetXML.get_bool_from_xml(p_xml, 'MasterValve')
l_sys.UsesPumpStartRelay = PutGetXML.get_bool_from_xml(p_xml, 'PumpRelay')
l_sys.Type = PutGetXML.get_text_from_xml(p_xml, 'Type')
for l_zone in p_xml.iterfind(ZONE):
l_obj = Xml._read_one_zone(l_zone)
l_sys.Zones[l_count] = l_obj
l_count += 1
except AttributeError as e_err:
LOG.error('Zone: {}'.format(e_err))
return l_sys
def _read_one_node_xml(p_node_xml):
"""
Use the passed in xml to create a node entry.
@param p_node_xml: is the element in the Xml config file that describes a node.
@return: a node object filled in.
"""
l_node_obj = NodeData()
XmlConfigTools.read_base_UUID_object_xml(l_node_obj, p_node_xml)
l_node_obj.ConnectionAddr_IPv4 = PutGetXML.get_text_from_xml(p_node_xml, 'ConnectionAddressV4')
l_node_obj.ConnectionAddr_IPv6 = PutGetXML.get_text_from_xml(p_node_xml, 'ConnectionAddressV6')
l_node_obj.NodeRole = PutGetXML.get_int_from_xml(p_node_xml, 'NodeRole')
try:
l_node_obj.LastUpdate = PutGetXML.get_date_time_from_xml(p_node_xml, 'LastUpdate')
except AttributeError:
l_node_obj.LastUpdate = datetime.datetime.now()
try:
l_node_obj.NodeInterfaces = Xml._read_interfaces_xml(p_node_xml.find('InterfaceSection'))
except AttributeError as e_err:
LOG.error('ERROR OneNodeRead error {}'.format(e_err))
return l_node_obj
def _read_one_bridge(p_xml):
""" Read all the information for a single Bridge device.
Call specific bridge information readers for some types of bridges.
@param p_xml: XML information for one Bridge.
@return: an Bridge object filled in with data from the XML passed in
"""
l_obj = BridgeData()
try:
XmlConfigTools.read_base_UUID_object_xml(l_obj, p_xml) # Name Key Active
l_obj.Connection = PutGetXML.get_text_from_xml(p_xml, 'Connection')
l_obj.Type = Xml._read_type(p_xml)
l_obj.IPv4Address = PutGetXML.get_ip_from_xml(p_xml, 'IPv4Address')
l_obj.TcpPort = PutGetXML.get_int_from_xml(p_xml, 'Port')
l_obj.UserName = PutGetXML.get_text_from_xml(p_xml, 'UserName')
l_obj.Password = PutGetXML.get_text_from_xml(p_xml, 'Password')
if l_obj.Type == "Hue":
hueXML.ReadXml(l_obj, p_xml)
except Exception:
pass
return l_obj
def _write_one_zone(p_obj):
"""
@param p_obj: is one zone object
@return the XML for one Zone
"""
l_xml = XmlConfigTools.write_base_object_xml('Zone', p_obj)
# PutGetXML.put_text_element(l_xml, 'Comment', p_obj.Comment)
PutGetXML.put_time_element(l_xml, 'Duration', p_obj.Duration)
PutGetXML.put_int_element(l_xml, 'EmitterCount', p_obj.EmitterCount)
PutGetXML.put_int_element(l_xml, 'EmitterType', p_obj.EmitterType)
PutGetXML.put_int_element(l_xml, 'NextZone', p_obj.Next)
PutGetXML.put_int_element(l_xml, 'PrevZone', p_obj.Previous)
PutGetXML.put_int_element(l_xml, 'Rate', p_obj.Rate)
PutGetXML.put_time_element(l_xml, 'StartTime', p_obj.StartTime)
return l_xml
def _write_one_zone(p_obj):
"""
@param p_obj: is one zone object
@return the XML for one Zone
"""
l_xml = XmlConfigTools.write_base_object_xml('Zone', p_obj)
PutGetXML.put_text_element(l_xml, 'Comment', p_obj.Comment)
PutGetXML.put_time_element(l_xml, 'Duration', p_obj.Duration)
PutGetXML.put_int_element(l_xml, 'EmitterCount', p_obj.EmitterCount)
PutGetXML.put_int_element(l_xml, 'EmitterType', p_obj.EmitterType)
PutGetXML.put_int_element(l_xml, 'NextZone', p_obj.Next)
PutGetXML.put_int_element(l_xml, 'PrevZone', p_obj.Previous)
PutGetXML.put_int_element(l_xml, 'Rate', p_obj.Rate)
PutGetXML.put_time_element(l_xml, 'StartTime', p_obj.StartTime)
return l_xml
def test_03_OneDevice1(self):
""" Test
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/OnkyoSection')
l_xml = l_xml.findall('Device')[1]
l_device = EntertainmentDeviceInformation()
# print(PrettyFormatAny.form(l_xml, 'C1-03-A - Onkyo XML'))
l_ret = entertainmentXML().read_entertainment_device(l_xml, l_device)
# print(PrettyFormatAny.form(l_ret, 'C1-03-B - Onkyo Device'))
self.assertEqual(l_ret.Name, TESTING_ONKYO_DEVICE_NAME_1)
self.assertEqual(str(l_ret.Active), TESTING_ONKYO_DEVICE_ACTIVE_1)
self.assertEqual(str(l_ret.Key), TESTING_ONKYO_DEVICE_KEY_1)
self.assertEqual(l_ret.Comment, TESTING_ONKYO_DEVICE_COMMENT_1)
def _write_one_bridge(p_bridge_obj):
""" Write all the information for a single Bridge device.
@param p_obj: is one broker object.
@return: the XML for one Broker System
"""
l_entry = XmlConfigTools.write_base_UUID_object_xml('Bridge', p_bridge_obj)
PutGetXML().put_text_element(l_entry, 'Connection', p_bridge_obj.Connection)
PutGetXML().put_text_element(l_entry, 'Type', p_bridge_obj.Type)
PutGetXML().put_ip_element(l_entry, 'IPv4Address', p_bridge_obj.IPv4Address)
PutGetXML().put_int_element(l_entry, 'Port', p_bridge_obj.TcpPort)
PutGetXML().put_text_element(l_entry, 'UserName', p_bridge_obj.UserName)
PutGetXML().put_text_element(l_entry, 'Password', p_bridge_obj.Password)
if p_bridge_obj.Type == "Hue":
hueXML.WriteXml(l_entry, p_bridge_obj)
return l_entry
def read_internet_xml(self, p_pyhouse_obj):
"""Reads zero or more <Internet> entries within the <InternetSection>
@param p_internet_section_xml: is the <InternetSection> element
"""
l_dict = {}
l_xml = XmlConfigTools.find_xml_section(
p_pyhouse_obj, 'ComputerDivision/InternetSection')
if l_xml == None:
return l_dict
l_count = 0
for l_internet in l_xml.iterfind('Internet'):
l_obj = Util._read_one_internet(l_internet)
l_dict[l_count] = l_obj
l_count += 1
LOG.info('Loaded {} Internet XML '.format(l_count))
return l_dict
def write_base_device_object_xml(p_element_tag, p_obj):
"""
@param p_element_tag: is the element name that we are going to create.
@param p_obj: is the object that contains the device data for which we will output the XML
@return: the XML element with children that we will create.
"""
l_elem = XmlConfigTools.write_base_UUID_object_xml(
p_element_tag, p_obj)
PutGetXML.put_text_element(l_elem, 'DeviceFamily', p_obj.DeviceFamily)
PutGetXML.put_text_element(l_elem, 'DeviceType', p_obj.DeviceType)
PutGetXML.put_text_element(l_elem, 'DeviceSubType',
p_obj.DeviceSubType)
PutGetXML.put_coords_element(l_elem, 'RoomCoords', p_obj.RoomCoords)
PutGetXML.put_text_element(l_elem, 'RoomName', p_obj.RoomName)
PutGetXML.put_text_element(l_elem, 'RoomUUID', p_obj.RoomUUID)
return l_elem
def _write_device(p_obj):
"""
@param p_obj: a filled in PandorDeviceData object
@return: An XML element for <Device> to be appended to <PandoraSection> Element
"""
l_xml = XmlConfigTools.write_base_object_xml('Device', p_obj)
PutGetXML.put_ip_element(l_xml, 'Host', p_obj.Host)
PutGetXML.put_text_element(l_xml, 'ConnectionFamily', p_obj.ConnectionFamily)
PutGetXML.put_text_element(l_xml, 'ConnectionName', p_obj.ConnectionName)
PutGetXML.put_text_element(l_xml, 'InputName', p_obj.InputName)
PutGetXML.put_text_element(l_xml, 'InputCode', p_obj.InputCode)
PutGetXML.put_text_element(l_xml, 'MaxPlayTime', p_obj.MaxPlayTime)
PutGetXML.put_text_element(l_xml, 'Type', p_obj.Type)
PutGetXML.put_int_element(l_xml, 'Volume', p_obj.Volume)
return l_xml
def test_02_OneDevice0(self):
""" Test that _create_module_refs is functional
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/PandoraSection')
l_service_xml = l_xml.findall('Service')
# print(PrettyFormatAny.form(l_service_xml[0], 'C2-02-A - Pandora XML'))
l_service = EntertainmentServiceInformation()
# print(PrettyFormatAny.form(l_service, 'C2-02-B - Pandora XML'))
l_ret = entertainmentXML().read_entertainment_service(
l_service_xml[0], l_service)
# print(PrettyFormatAny.form(l_ret, 'C2-02-C - Pandora Service'))
self.assertEqual(l_ret.Name, TESTING_PANDORA_SERVICE_NAME_0)
self.assertEqual(str(l_ret.Active), TESTING_PANDORA_SERVICE_ACTIVE_0)
self.assertEqual(str(l_ret.Key), TESTING_PANDORA_SERVICE_KEY_0)
self.assertEqual(l_ret.Comment, TESTING_PANDORA_SERVICE_COMMENT_0)
def test_03_Pandora(self):
"""
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/PandoraSection')
# print(PrettyFormatAny.form(l_xml, 'C3-03-A - Pandora XML'))
l_ret = entertainmentXML().read_entertainment_subsection(
self.m_pyhouse_obj, l_xml)
# print(PrettyFormatAny.form(l_ret, 'C3-03-B - Pandora Plugin'))
# print(PrettyFormatAny.form(l_ret.Services, 'C3-03-C - Pandora Services'))
self.assertEqual(l_ret.Services[0].Name,
TESTING_PANDORA_SERVICE_NAME_0)
self.assertEqual(str(l_ret.Services[0].Active),
TESTING_PANDORA_SERVICE_ACTIVE_0)
self.assertEqual(str(l_ret.Services[0].Key),
TESTING_PANDORA_SERVICE_KEY_0)
self.assertEqual(l_ret.Services[0].Comment,
TESTING_PANDORA_SERVICE_COMMENT_0)
def test_02_Onkyo(self):
""" Test All of onkyo loads
"""
l_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/OnkyoSection')
# print(PrettyFormatAny.form(l_xml, 'C3-02-A - Onkyo XML'))
l_ret = entertainmentXML().read_entertainment_subsection(
self.m_pyhouse_obj, l_xml)
# print(PrettyFormatAny.form(l_ret, 'C3-02-B - Onkyo Plugin'))
# print(PrettyFormatAny.form(l_ret.Devices, 'C3-02-C - Onkyo Devices'))
self.assertEqual(l_ret.Active, TESTING_ONKYO_ACTIVE)
self.assertEqual(l_ret.Name, 'onkyo')
self.assertEqual(l_ret.Devices[0].Name, TESTING_ONKYO_DEVICE_NAME_0)
self.assertEqual(str(l_ret.Devices[0].Active),
TESTING_ONKYO_DEVICE_ACTIVE_0)
self.assertEqual(str(l_ret.Devices[0].Key), TESTING_ONKYO_DEVICE_KEY_0)
self.assertEqual(l_ret.Devices[0].Comment,
TESTING_ONKYO_DEVICE_COMMENT_0)
def _module_load_loop(self, p_pyhouse_obj, p_section_element):
"""
"""
l_active = True
l_plugin_data = EntertainmentPluginData()
l_plugin_data.Name = l_name = XmlConfigTools.extract_section_name(p_section_element)
l_plugin_data.Active = l_active # = PutGetXML.get_bool_from_xml(p_section_element, 'Active', True)
LOG.debug('Working on {}'.format(l_name))
if l_active:
# Create the module plugin
l_module_name = 'Modules.Housing.Entertainment.' + l_name + '.' + l_name
l_module = importlib.import_module(l_module_name)
l_plugin_data.Module = l_module
# Initialize Plugin
l_plugin_data._API = l_module.API(self.m_pyhouse_obj)
p_pyhouse_obj.House.Entertainment.Plugins[l_name] = l_plugin_data
LOG.info('Created Entertainment Plugin "{}".'.format(l_name))
# Load XML for Plugin
l_devices = l_plugin_data._API.LoadXml(p_pyhouse_obj)
l_plugin_data.Devices = l_devices.Devices
def write_base_device_object_xml(p_element_tag, p_obj):
"""
@param p_element_tag: is the element name that we are going to create.
@param p_obj: is the object that contains the device data for which we will output the XML
@return: the XML element with children that we will create.
"""
# l_elem = ET.Element(p_element_tag)
l_elem = XmlConfigTools.write_base_UUID_object_xml(p_element_tag, p_obj)
PutGetXML.put_text_attribute(l_elem, 'Name', p_obj.Name)
PutGetXML.put_int_attribute(l_elem, 'Key', p_obj.Key)
PutGetXML.put_bool_attribute(l_elem, 'Active', p_obj.Active)
# add sub elements
PutGetXML.put_text_element(l_elem, 'Comment', p_obj.Comment)
PutGetXML.put_text_element(l_elem, 'DeviceFamily', p_obj.DeviceFamily)
PutGetXML.put_int_element(l_elem, 'DeviceType', p_obj.DeviceType)
PutGetXML.put_int_element(l_elem, 'DeviceSubType', p_obj.DeviceSubType)
PutGetXML.put_coords_element(l_elem, 'RoomCoords', p_obj.RoomCoords)
PutGetXML.put_text_element(l_elem, 'RoomName', p_obj.RoomName)
PutGetXML.put_text_element(l_elem, 'RoomUUID', p_obj.RoomUUID)
return l_elem
def read_web_xml(p_pyhouse_obj):
"""
PyHouse.Computer.Web.
Logins
WebPort
@param p_pyhouse_xml: is the entire PyHouse Object
"""
l_obj = WebInformation()
l_obj.Logins = Xml._add_default_login()
l_obj.WebPort = 8580
l_obj.SecurePort = 8588
l_obj.WebSocketPort = 8581
l_xml = XmlConfigTools.find_xml_section(p_pyhouse_obj,
'ComputerDivision/WebSection')
if l_xml == None:
return l_obj
l_obj.Logins, l_count = Xml._read_all_logins(l_xml)
l_obj.WebPort, l_obj.SecurePort, l_obj.WebSocketPort = Xml._read_ports(
l_xml)
LOG.info('Loaded {} logins.'.format(l_count))
return l_obj
def read_samsung_section_xml(p_pyhouse_obj):
l_xml = XmlConfigTools.find_section(p_pyhouse_obj, 'HouseDivision/EntertainmentSection/SamsungSection')
l_entertain_obj = p_pyhouse_obj.House.Entertainment
l_plugin_obj = l_entertain_obj.Plugins[SECTION]
l_plugin_obj.Name = SECTION
l_plugin_obj.Active = PutGetXML.get_bool_from_xml(l_xml, 'Active')
l_count = 0
if l_xml is None:
return l_plugin_obj
try:
l_plugin_obj.Type = PutGetXML.get_text_from_xml(l_xml, 'Type')
for l_device_xml in l_xml.iterfind('Device'):
l_device_obj = XML._read_device(l_device_xml)
l_device_obj.Key = l_count
l_plugin_obj.Devices[l_count] = l_device_obj
LOG.info('Loaded {} Device {}'.format(SECTION, l_plugin_obj.Name))
l_count += 1
l_plugin_obj.Count = l_count
except AttributeError as e_err:
LOG.error('ERROR if getting {} Device Data - {}'.format(SECTION, e_err))
p_pyhouse_obj.House.Entertainment.Plugins[SECTION] = l_plugin_obj
LOG.info('Loaded {} {} Device(s).'.format(l_count, SECTION))
return l_plugin_obj
def LoadXml(self, p_pyhouse_obj):
""" Read the entertainment section.
Everything present in the XML must be read into the pyhouse_obj structure.
SubSections not active will not be loaded or instantiated.
If a subsection is available, load its module and let it read the xml for itself.
@return: the Entertainment object of PyHouse_obj
"""
LOG.info("XML Loading - Version:{}".format(__version__))
l_entertain = p_pyhouse_obj.House.Entertainment
l_xml = XmlConfigTools.find_section(p_pyhouse_obj, 'HouseDivision/EntertainmentSection')
if l_xml == None:
l_entertain.Active = False
return l_entertain
l_count = 0
for l_section_element in l_xml:
self._module_load_loop(p_pyhouse_obj, l_section_element)
l_count += 1
l_entertain.Active = True
l_entertain.Count = l_count
LOG.info('XML Loaded {} Entertainment Sections'.format(l_count))
return l_entertain
def _read_base(p_pool_element):
l_pool_obj = PoolData()
XmlConfigTools.read_base_UUID_object_xml(l_pool_obj, p_pool_element)
return l_pool_obj
def write_computer_xml(p_pyhouse_obj):
l_xml = XmlConfigTools.write_base_UUID_object_xml(
COMPUTER_DIVISION, p_pyhouse_obj.Computer)
return l_xml
def _write_base(p_obj):
l_entry = XmlConfigTools.write_base_UUID_object_xml('Pool', p_obj)
return l_entry
def _write_one_pool(p_pool_obj):
l_entry = XmlConfigTools.write_base_UUID_object_xml('Pool', p_pool_obj)
# PutGetXML().put_text_element(l_entry, 'Comment', p_pool_obj.Comment)
PutGetXML().put_text_element(l_entry, 'PoolType', p_pool_obj.PoolType)
return l_entry
def setUp(self, p_root):
self.m_pyhouse_obj = SetupPyHouseObj().BuildPyHouseObj(p_root)
self.m_xml = SetupPyHouseObj().BuildXml(p_root)
self.m_api = PutGetXML
self.m_apix = XmlConfigTools()
def setUp(self):
SetupMixin.setUp(self, ET.fromstring(XML_LONG))
# l_ret = entertainmentXML().read_entertainment_all(self.m_pyhouse_obj)
self.m_xml_onkyo_sect = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj,
'HouseDivision/EntertainmentSection/OnkyoSection')
def setUp(self):
SetupMixin.setUp(self, ET.fromstring(BAD_TYPE))
self.m_xml = XmlConfigTools.find_xml_section(
self.m_pyhouse_obj, 'HouseDivision/EntertainmentSection')
