rf-protocols 3.0.0__tar.gz → 3.2.0__tar.gz

{rf_protocols-3.0.0 → rf_protocols-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rf-protocols
-Version: 3.0.0
+Version: 3.2.0
 Summary: Library to decode and encode radio frequency signals.
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols

{rf_protocols-3.0.0 → rf_protocols-3.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name         = "rf-protocols"
-version      = "3.0.0"
+version      = "3.2.0"
 license      = "MIT"
 description  = "Library to decode and encode radio frequency signals."
 readme       = "README.md"

rf_protocols-3.2.0/rf_protocols/commands/ev1527.py

@@ -0,0 +1,124 @@
+"""Protocol for EV1527 compatible devices 
+
+EV1527, RT1527, FP1527 is a simple 24-bit RF protocol used by self-learning remote controls
+and RF switches. It uses Pulse Width Modulation (PWM) encoding where a wide
+pulse represents 1 and a short pulse represents 0.
+The chip has a fixed 20-bit device id and 4 data pin inputs, which are typically used to encode a button or channel number.
+The protocol uses a configurable time base (step duration). Common manufacturers
+and their step durations:
+- Logilight radio controlled sockets EC0001-EC0004: ~300 µs
+- eMylo switches: ~350 µs
+
+Encoding:
+Each bit is encoded as follows:
+
+			 ____
+Bit 0    : _|    |____________
+			|<1a>|<---3a---->|
+
+			 ____________
+Bit 1    : _|            |____
+			|<----3a---->|<1a>|
+
+			 ____
+Sync     : _|    |___________ _ _ _ ____________
+			|<1a>|<-----------31a------------->|
+
+Telegram layout:
+- Sync
+- 24 data bits
+- End of transmission
+
+Common data layout:
+- 20 bits: device/unit code
+- 4 bits: button/channel
+
+Reference:
+https://www.seegel-systeme.de/2015/09/05/funksteckdosen-mit-dem-raspberry-pi-steuern/
+http://www.sc-tech.cn/en/EV1527.pdf
+"""
+
+from __future__ import annotations
+
+from typing import override
+
+from . import ModulationType, RadioFrequencyCommand
+
+_DEFAULT_FREQUENCY = 433_920_000
+_DEFAULT_REPEATS = 4
+_DEFAULT_TIMEBASE_US = 275
+
+
+class EV1527Command(RadioFrequencyCommand):
+	"""Encode an EV1527-compatible RF command.
+
+	Data layout:
+	- 20 bits: device ID
+	- 4 bits: data/button (0..15)
+	"""
+
+	device_id: int
+	data: int
+	timebase_us: int
+
+	def __init__(
+		self,
+		*,
+		device_id: int,
+		data: int,
+		frame_repeats: int = _DEFAULT_REPEATS,
+		frequency: int = _DEFAULT_FREQUENCY,
+		timebase_us: int = _DEFAULT_TIMEBASE_US,
+	) -> None:
+		"""Initialize the EV1527 command.
+
+		Args:
+			device_id: 20-bit device ID (0..1048575)
+			data: Data/button bits (0..15)
+			frame_repeats: Number of times to repeat the frame
+			frequency: RF frequency in Hz
+			timebase_us: Time base in microseconds
+		"""
+
+		if device_id < 0 or device_id >= (1 << 20):
+			raise ValueError("device_id must be in range 0..1048575 (20-bit)")
+		if data < 0 or data > 15:
+			raise ValueError("data must be in range 0..15")
+
+		super().__init__(
+			frequency=frequency,
+			modulation=ModulationType.OOK,
+			repeat_count=frame_repeats,
+		)
+		self.device_id = device_id
+		self.data = data
+		self.timebase_us = timebase_us
+
+	@override
+	def get_raw_timings(self) -> list[int]:
+		"""Compute EV1527 frame timings using PWM encoding.
+
+		Encodes: sync + 24 data bits (LSB first).
+		"""
+		# PWM symbol definitions (1a = short, 3a = long)
+		_symbols = {
+			"0": [self.timebase_us, -3 * self.timebase_us],
+			"1": [3 * self.timebase_us, -self.timebase_us],
+			"sync": [self.timebase_us, -31 * self.timebase_us],
+		}
+
+		# Encode 20-bit device ID in LSB (reverse bits)
+		device_id_bits = format(self.device_id, "020b")[::-1]
+		symstr: list[str] = [*device_id_bits]
+
+		# Encode 4-bit data in LSB (reverse bits)
+		data_bits = format(self.data, "04b")[::-1]
+		symstr.extend(data_bits)
+
+		# Build timings: sync + symbols
+		timings: list[int] = []
+		timings.extend(_symbols["sync"])
+		for s in symstr:
+			timings.extend(_symbols[s])
+
+		return timings

rf_protocols-3.2.0/rf_protocols/commands/kaku.py

@@ -0,0 +1,153 @@
+"""Protocol for KAKU compatible devices.
+
+Pulse Position Modulation with 32 or 36 symbols, used by self-learning
+Intertechno-type sockets and compatible devices (for example some Hama models).
+
+Symbols use a time base ``T``:
+
+			 ____      ____
+Bit 0    : _|    |____|    |____________________
+			|<1T>|<1T>|<1T>|<--------5T-------->|
+
+			 ____                      ____
+Bit 1    : _|    |____________________|    |____
+			|<1T>|<--------5T-------->|<1T>|<1T>|
+
+			 ____      ____
+Bit X    : _|    |____|    |____
+			|<1T>|<1T>|<1T>|<1T>|
+
+			 ____
+Sync     : _|    |_________ _ _ _ ________
+			|<1T>|<----------11T--------->|
+
+			 ____
+Pause    : _|    |___________ _ _ _ ____________
+			|<1T>|<-----------39T-------------->|
+
+Telegram layout:
+- Sync
+- 32 or 36 symbols
+- Pause
+
+Each transmission is typically repeated four times.
+
+Common bit assignment for KAKU-style devices:
+- 26 bits system code
+- 1 bit group (0=single, 1=group)
+- 1 bit on/off
+- 4 bits channel
+
+Dimming commands:
+- 26 bits system code
+- 1 bit group (0=single, 1=group)
+- 1 bit X
+- 4 bits channel
+- 4 bits dim level (0-15)
+
+Manufacturer-specific notes from the reference:
+- Intertechno (self-learning): step duration around 275 us
+- Hama 00121938: similar format, step duration around 250 us, inverted channel bits
+
+Reference chapter:
+https://www.seegel-systeme.de/2015/09/05/funksteckdosen-mit-dem-raspberry-pi-steuern/
+"""
+
+from __future__ import annotations
+
+from typing import override
+
+from . import ModulationType, RadioFrequencyCommand
+
+_DEFAULT_FREQUENCY = 433_920_000
+_DEFAULT_REPEATS = 4
+_DEFAULT_TIMEBASE_US = 275
+
+
+class KakuCommand(RadioFrequencyCommand):
+	"""Encode a KAKU-compatible PPM frame.
+
+	Data layout is either:
+	- 32 symbols: 26-bit id, group bit, on/off bit, 4-bit channel
+	- 36 symbols: 26-bit id, group bit, X symbol, 4-bit channel, 4-bit dim level
+	"""
+
+	id: int
+	group: bool
+	channel: int
+	on: bool | None
+	dimlevel: int | None
+	timebase_us: int
+
+	def __init__(
+		self,
+		*,
+		id: int,
+		group: bool,
+		channel: int | None = None,
+		on: bool | None = None,
+		dimlevel: int | None = None,
+		frame_repeats: int = _DEFAULT_REPEATS,
+		frequency: int = _DEFAULT_FREQUENCY,
+		timebase_us: int = _DEFAULT_TIMEBASE_US,
+	) -> None:
+		"""Initialize the KAKU command."""
+
+		if id < 0 or id >= (1 << 26):
+			raise ValueError("id must be in range 0..67108863 (26-bit)")
+		if channel is None:
+			if not group:
+				raise ValueError("channel is required when group is False")
+			channel = 1
+		if channel < 1 or channel > 16:
+			raise ValueError("channel must be in range 1..16")
+		if (on is None) == (dimlevel is None):
+			raise ValueError("provide exactly one of 'on' or 'dimlevel'")
+		if dimlevel is not None and (dimlevel < 0 or dimlevel > 100):
+			raise ValueError("dimlevel must be in range 0..100")
+
+		super().__init__(
+			frequency=frequency,
+			modulation=ModulationType.OOK,
+			repeat_count=frame_repeats,
+		)
+		self.id = id
+		self.group = group
+		self.channel = channel
+		self.on = on
+		self.dimlevel = dimlevel
+		self.timebase_us = timebase_us
+
+	@override
+	def get_raw_timings(self) -> list[int]:
+		"""Compute KAKU PPM frame timings."""
+		_symbols = {
+			"0": [self.timebase_us, -self.timebase_us, self.timebase_us, -5 * self.timebase_us],
+			"1": [self.timebase_us, -5 * self.timebase_us, self.timebase_us, -self.timebase_us],
+			"X": [self.timebase_us, -self.timebase_us, self.timebase_us, -self.timebase_us],
+			"sync": [self.timebase_us, -11 * self.timebase_us],
+			"pause": [self.timebase_us, -39 * self.timebase_us],
+		}
+
+		# add ID and group bit
+		symstr: list[str] = [*format(self.id, "026b"), "1" if self.group else "0"]
+
+		if self.dimlevel is None:
+			# add on/off bit
+			symstr.append("1" if self.on else "0")
+		else:
+			# add X symbol
+			symstr.append("X")
+
+		symstr.extend(format(self.channel - 1, "04b"))
+		if self.dimlevel is not None:
+			dim_steps = round(self.dimlevel * 15 / 100)
+			symstr.extend(format(dim_steps, "04b"))
+
+		timings: list[int] = []
+		timings.extend(_symbols["sync"])
+		for s in symstr:
+			timings.extend(_symbols[s])
+		timings.extend(_symbols["pause"])
+
+		return timings

{rf_protocols-3.0.0 → rf_protocols-3.2.0}/rf_protocols.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rf-protocols
-Version: 3.0.0
+Version: 3.2.0
 Summary: Library to decode and encode radio frequency signals.
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/home-assistant-libs/rf-protocols

{rf_protocols-3.0.0 → rf_protocols-3.2.0}/rf_protocols.egg-info/SOURCES.txt

@@ -65,6 +65,8 @@ rf_protocols/codes/novy/cooker_hood/code_9/plus.sub
 rf_protocols/codes/novy/cooker_hood/code_9/power.sub
 rf_protocols/codes/somfy/rts/__init__.py
 rf_protocols/commands/__init__.py
+rf_protocols/commands/ev1527.py
+rf_protocols/commands/kaku.py
 rf_protocols/commands/ook.py
 rf_protocols/commands/pt2262.py
 rf_protocols/commands/somfy_rts.py