Skip to content

Commit

Permalink
Channel energy scan (#149)
Browse files Browse the repository at this point in the history
* XBee: energy scan

* convert values

* add test

* improve test

* apply suggestions from code review
  • Loading branch information
Shulyaka authored Oct 1, 2023
1 parent f387a0f commit f1eeca8
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 2 deletions.
29 changes: 29 additions & 0 deletions tests/test_application.py
Original file line number Diff line number Diff line change
Expand Up @@ -597,3 +597,32 @@ async def test_move_network_to_channel(app):

assert len(app._api._queued_at.mock_calls) == 1
app._api._queued_at.assert_any_call("SC", 1 << (26 - 11))


async def test_energy_scan(app):
rssi = b"\x0A\x0F\x14\x19\x1E\x23\x28\x2D\x32\x37\x3C\x41\x46\x4B\x50\x55"
app._api._at_command = mock.AsyncMock(spec=XBee._at_command, return_value=rssi)
time_s = 3
count = 3
energy = await app.energy_scan(
channels=[x for x in range(11, 27)], duration_exp=time_s, count=count
)
assert app._api._at_command.mock_calls == [mock.call("ED", time_s)] * count
assert {k: round(v, 3) for k, v in energy.items()} == {
11: 254.032,
12: 253.153,
13: 251.486,
14: 248.352,
15: 242.562,
16: 232.193,
17: 214.619,
18: 187.443,
19: 150.853,
20: 109.797,
21: 72.172,
22: 43.571,
23: 24.769,
24: 13.56,
25: 7.264,
26: 3.844,
}
2 changes: 2 additions & 0 deletions zigpy_xbee/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ class ModemStatus(t.uint8_t, t.UndefinedEnum):
"D7": t.uint8_t, # 0 - 7 (an Enum)
"P3": t.uint8_t, # 0 - 5 (an Enum)
"P4": t.uint8_t, # 0 - 5 (an Enum)
# MAC diagnostics commands
"ED": t.Bytes, # 16-byte value
# I/O commands
"IR": t.uint16_t,
"IC": t.uint16_t,
Expand Down
35 changes: 33 additions & 2 deletions zigpy_xbee/zigbee/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import asyncio
import logging
import math
import statistics
import time
from typing import Any

Expand Down Expand Up @@ -181,9 +183,38 @@ async def energy_scan(
self, channels: zigpy.types.Channels, duration_exp: int, count: int
) -> dict[int, float]:
"""Runs an energy detection scan and returns the per-channel scan results."""
all_results = {}

LOGGER.warning("Coordinator does not support energy scanning")
return {c: 0 for c in channels}
for _ in range(count):
results = await self._api._at_command("ED", duration_exp)
results = {
channel: -int(rssi) for channel, rssi in zip(range(11, 27), results)
}

for channel, rssi in results.items():
all_results.setdefault(channel, []).append(rssi)

def logistic(x: float, *, L: float = 1, x_0: float = 0, k: float = 1) -> float:
"""Logistic function."""
return L / (1 + math.exp(-k * (x - x_0)))

def map_rssi_to_energy(rssi: int) -> float:
"""Remaps RSSI (in dBm) to Energy (0-255)."""
RSSI_MAX = -5
RSSI_MIN = -92
return logistic(
x=rssi,
L=255,
x_0=RSSI_MIN + 0.45 * (RSSI_MAX - RSSI_MIN),
k=0.13,
)

energy = {
channel: map_rssi_to_energy(statistics.mean(all_rssi))
for channel, all_rssi in all_results.items()
}

return {channel: energy.get(channel, 0) for channel in channels}

async def force_remove(self, dev):
"""Forcibly remove device from NCP."""
Expand Down

0 comments on commit f1eeca8

Please sign in to comment.