Solaar/logitech/unifying_receiver/tests/test_50_api.py

#
#
#

import unittest

from logitech.unifying_receiver import api
from logitech.unifying_receiver.exceptions import *
from logitech.unifying_receiver.constants import *


class Test_UR_API(unittest.TestCase):
	@classmethod
	def setUpClass(cls):
		cls.handle = None
		cls.device = None
		cls.features_array = None

	@classmethod
	def tearDownClass(cls):
		if cls.handle:
			api.close(cls.handle)
		cls.device = None
		cls.features_array = None

	def test_00_open_receiver(self):
		Test_UR_API.handle = api.open()
		if self.handle is None:
			self.fail("No receiver found")

	def test_05_ping_device_zero(self):
		if self.handle is None:
			self.fail("No receiver found")

		ok = api.ping(self.handle, 0)
		self.assertIsNotNone(ok, "invalid ping reply")
		self.assertFalse(ok, "device zero replied")

	def test_10_ping_all_devices(self):
		if self.handle is None:
			self.fail("No receiver found")

		devices = []

		for device in range(1, 1 + api.base.MAX_ATTACHED_DEVICES):
			ok = api.ping(self.handle, device)
			self.assertIsNotNone(ok, "invalid ping reply")
			if ok:
				devices.append(device)

		if devices:
			Test_UR_API.device = devices[0]

	def test_30_get_feature_index(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")

		fs_index = api.get_feature_index(self.handle, self.device, FEATURE.FEATURE_SET)
		self.assertIsNotNone(fs_index, "feature FEATURE_SET not available")
		self.assertGreater(fs_index, 0, "invalid FEATURE_SET index: " + str(fs_index))

	def test_31_bad_feature(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")

		reply = api.request(self.handle, self.device, FEATURE.ROOT, params=b'\xFF\xFF')
		self.assertIsNotNone(reply, "invalid reply")
		self.assertEquals(reply[:5], b'\x00' * 5, "invalid reply")

	def test_40_get_device_features(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")

		features = api.get_device_features(self.handle, self.device)
		self.assertIsNotNone(features, "failed to read features array")
		self.assertIn(FEATURE.FEATURE_SET, features, "feature FEATURE_SET not available")
		# cache this to simplify next tests
		Test_UR_API.features_array = features

	def test_50_get_device_firmware(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")
		if self.features_array is None:
			self.fail("no feature set available")

		d_firmware = api.get_device_firmware(self.handle, self.device, self.features_array)
		self.assertIsNotNone(d_firmware, "failed to get device type")
		self.assertGreater(len(d_firmware), 0, "empty device type")

	def test_52_get_device_type(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")
		if self.features_array is None:
			self.fail("no feature set available")

		d_type = api.get_device_type(self.handle, self.device, self.features_array)
		self.assertIsNotNone(d_type, "failed to get device type")
		self.assertGreater(len(d_type), 0, "empty device type")

	def test_55_get_device_name(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")
		if self.features_array is None:
			self.fail("no feature set available")

		d_name = api.get_device_name(self.handle, self.device, self.features_array)
		self.assertIsNotNone(d_name, "failed to read device name")
		self.assertGreater(len(d_name), 0, "empty device name")

	def test_60_get_battery_level(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")
		if self.features_array is None:
			self.fail("no feature set available")

		try:
			battery = api.get_device_battery_level(self.handle, self.device, self.features_array)
			self.assertIsNotNone(battery, "failed to read battery level")
		except FeatureNotSupported:
			self.fail("BATTERY feature not supported by device " + str(self.device))

	def test_70_list_devices(self):
		if self.handle is None:
			self.fail("No receiver found")

		all_devices = api.list_devices(self.handle)
		if all_devices:
			self.assertIsNotNone(self.device)
			for device_info in all_devices:
				self.assertIsInstance(device_info, api.AttachedDeviceInfo)
		else:
			self.assertIsNone(self.device)

	def test_70_find_device_by_name(self):
		if self.handle is None:
			self.fail("No receiver found")
		if self.device is None:
			self.fail("Found no devices attached.")

		all_devices = api.list_devices(self.handle)
		for device_info in all_devices:
			device = api.find_device_by_name(self.handle, device_info.name)
			self.assertEquals(device, device_info)

if __name__ == '__main__':
	unittest.main()