Skip to content

Commit 61a2561

Browse files
agnersagners
authored
[Python] Drop deprecated discovery APIs (#33882)
This change removes the deprecated discovery APIs from the Python controller. The APIs that are removed are: - DiscoverCommissionableNodesLongDiscriminator - DiscoverCommissionableNodesShortDiscriminator - DiscoverCommissionableNodesVendor - DiscoverCommissionableNodesDeviceType - DiscoverCommissionableNodesCommissioningEnabled - PrintDiscoveredDevices - DiscoverAllCommissioning All these APIs can be replaced with the DiscoverCommissionableNodes and the appropriate filter flags.
1 parent 2d97cda commit 61a2561

File tree

4 files changed

+0
-289
lines changed

4 files changed

+0
-289
lines changed

‎docs/testing/ChipDeviceCtrlAPI.md

-77
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@
1010
- [ShutdownAll](#shutdownall)
1111
- [ExpireSessions](#expiresessions)
1212
- [DiscoverCommissionableNodes](#discovercommissionablenodes)
13-
- [DiscoverCommissionableNodesLongDiscriminator](#discovercommissionablenodeslongdiscriminator)
14-
- [DiscoverCommissionableNodesShortDiscriminator](#discovercommissionablenodesshortdiscriminator)
15-
- [DiscoverCommissionableNodesVendor](#discovercommissionablenodesvendor)
16-
- [DiscoverCommissionableNodesDeviceType](#discovercommissionablenodesdevicetype)
17-
- [DiscoverCommissionableNodesCommissioningEnabled](#discovercommissionablenodescommissioningenabled)
18-
- [PrintDiscoveredDevices](#printdiscovereddevices)
19-
- [DiscoverAllCommissioning](#discoverallcommissioning)
2013
- [OpenCommissioningWindow](#opencommissioningwindow)
2114
- [GetFabricIdInternal](#getfabricidinternal)
2215
- [GetNodeIdInternal](#getnodeidinternal)
@@ -174,76 +167,6 @@ This function will always return a list of CommissionableDevice. When
174167
stopOnFirst is set, this function will return when at least one device is
175168
discovered or on timeout.
176169

177-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesLongDiscriminator"></a>
178-
179-
#### DiscoverCommissionableNodesLongDiscriminator
180-
181-
```python
182-
def DiscoverCommissionableNodesLongDiscriminator(long_discriminator)
183-
```
184-
185-
Deprecated, use DiscoverCommissionableNodes
186-
187-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesShortDiscriminator"></a>
188-
189-
#### DiscoverCommissionableNodesShortDiscriminator
190-
191-
```python
192-
def DiscoverCommissionableNodesShortDiscriminator(short_discriminator)
193-
```
194-
195-
Deprecated, use DiscoverCommissionableNodes
196-
197-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesVendor"></a>
198-
199-
#### DiscoverCommissionableNodesVendor
200-
201-
```python
202-
def DiscoverCommissionableNodesVendor(vendor)
203-
```
204-
205-
Deprecated, use DiscoverCommissionableNodes
206-
207-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesDeviceType"></a>
208-
209-
#### DiscoverCommissionableNodesDeviceType
210-
211-
```python
212-
def DiscoverCommissionableNodesDeviceType(device_type)
213-
```
214-
215-
Deprecated, use DiscoverCommissionableNodes
216-
217-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverCommissionableNodesCommissioningEnabled"></a>
218-
219-
#### DiscoverCommissionableNodesCommissioningEnabled
220-
221-
```python
222-
def DiscoverCommissionableNodesCommissioningEnabled()
223-
```
224-
225-
Deprecated, use DiscoverCommissionableNodes
226-
227-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.PrintDiscoveredDevices"></a>
228-
229-
#### PrintDiscoveredDevices
230-
231-
```python
232-
def PrintDiscoveredDevices()
233-
```
234-
235-
Deprecated, use GetCommissionableNodes
236-
237-
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.DiscoverAllCommissioning"></a>
238-
239-
#### DiscoverAllCommissioning
240-
241-
```python
242-
def DiscoverAllCommissioning()
243-
```
244-
245-
Deprecated, use DiscoverCommissionableNodes
246-
247170
<a id="chip.ChipDeviceCtrl.ChipDeviceControllerBase.OpenCommissioningWindow"></a>
248171

249172
#### OpenCommissioningWindow

‎src/controller/python/ChipDeviceController-Discovery.cpp

-60
Original file line numberDiff line numberDiff line change
@@ -169,66 +169,6 @@ void pychip_DeviceController_IterateDiscoveredCommissionableNodes(Controller::De
169169
}
170170
}
171171

172-
void pychip_DeviceController_PrintDiscoveredDevices(Controller::DeviceCommissioner * devCtrl)
173-
{
174-
for (int i = 0; i < devCtrl->GetMaxCommissionableNodesSupported(); ++i)
175-
{
176-
const Dnssd::CommissionNodeData * dnsSdInfo = devCtrl->GetDiscoveredDevice(i);
177-
if (dnsSdInfo == nullptr)
178-
{
179-
continue;
180-
}
181-
char rotatingId[Dnssd::kMaxRotatingIdLen * 2 + 1] = "";
182-
Encoding::BytesToUppercaseHexString(dnsSdInfo->rotatingId, dnsSdInfo->rotatingIdLen, rotatingId, sizeof(rotatingId));
183-
184-
ChipLogProgress(Discovery, "Commissionable Node %d", i);
185-
ChipLogProgress(Discovery, "\tInstance name:\t\t%s", dnsSdInfo->instanceName);
186-
ChipLogProgress(Discovery, "\tHost name:\t\t%s", dnsSdInfo->hostName);
187-
ChipLogProgress(Discovery, "\tPort:\t\t\t%u", dnsSdInfo->port);
188-
ChipLogProgress(Discovery, "\tLong discriminator:\t%u", dnsSdInfo->longDiscriminator);
189-
ChipLogProgress(Discovery, "\tVendor ID:\t\t%u", dnsSdInfo->vendorId);
190-
ChipLogProgress(Discovery, "\tProduct ID:\t\t%u", dnsSdInfo->productId);
191-
ChipLogProgress(Discovery, "\tCommissioning Mode\t%u", dnsSdInfo->commissioningMode);
192-
ChipLogProgress(Discovery, "\tDevice Type\t\t%u", dnsSdInfo->deviceType);
193-
ChipLogProgress(Discovery, "\tDevice Name\t\t%s", dnsSdInfo->deviceName);
194-
ChipLogProgress(Discovery, "\tRotating Id\t\t%s", rotatingId);
195-
ChipLogProgress(Discovery, "\tPairing Instruction\t%s", dnsSdInfo->pairingInstruction);
196-
ChipLogProgress(Discovery, "\tPairing Hint\t\t%u", dnsSdInfo->pairingHint);
197-
198-
auto idleInterval = dnsSdInfo->GetMrpRetryIntervalIdle();
199-
if (idleInterval.has_value())
200-
{
201-
ChipLogProgress(Discovery, "\tMrp Interval idle\t%u", idleInterval->count());
202-
}
203-
else
204-
{
205-
ChipLogProgress(Discovery, "\tMrp Interval idle\tNot present");
206-
}
207-
208-
auto activeInterval = dnsSdInfo->GetMrpRetryIntervalActive();
209-
if (activeInterval.has_value())
210-
{
211-
ChipLogProgress(Discovery, "\tMrp Interval active\t%u", activeInterval->count());
212-
}
213-
else
214-
{
215-
ChipLogProgress(Discovery, "\tMrp Interval active\tNot present");
216-
}
217-
218-
ChipLogProgress(Discovery, "\tSupports TCP\t\t%d", dnsSdInfo->supportsTcp);
219-
if (dnsSdInfo->isICDOperatingAsLIT.has_value())
220-
{
221-
ChipLogProgress(Discovery, "\tICD is operating as a\t%s", *(dnsSdInfo->isICDOperatingAsLIT) ? "LIT" : "SIT");
222-
}
223-
for (unsigned j = 0; j < dnsSdInfo->numIPs; ++j)
224-
{
225-
char buf[Inet::IPAddress::kMaxStringLength];
226-
dnsSdInfo->ipAddress[j].ToString(buf);
227-
ChipLogProgress(Discovery, "\tAddress %d:\t\t%s", j, buf);
228-
}
229-
}
230-
}
231-
232172
bool pychip_DeviceController_GetIPForDiscoveredDevice(Controller::DeviceCommissioner * devCtrl, int idx, char * addrStr,
233173
uint32_t len)
234174
{

‎src/controller/python/ChipDeviceController-ScriptBinding.cpp

-53
Original file line numberDiff line numberDiff line change
@@ -166,18 +166,6 @@ PyChipError pychip_DeviceController_EstablishPASESession(chip::Controller::Devic
166166
chip::NodeId nodeid);
167167
PyChipError pychip_DeviceController_Commission(chip::Controller::DeviceCommissioner * devCtrl, chip::NodeId nodeid);
168168

169-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesLongDiscriminator(chip::Controller::DeviceCommissioner * devCtrl,
170-
uint16_t long_discriminator);
171-
PyChipError pychip_DeviceController_DiscoverAllCommissionableNodes(chip::Controller::DeviceCommissioner * devCtrl);
172-
173-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesShortDiscriminator(chip::Controller::DeviceCommissioner * devCtrl,
174-
uint16_t short_discriminator);
175-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesVendor(chip::Controller::DeviceCommissioner * devCtrl,
176-
uint16_t vendor);
177-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesDeviceType(chip::Controller::DeviceCommissioner * devCtrl,
178-
uint16_t device_type);
179-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesCommissioningEnabled(chip::Controller::DeviceCommissioner * devCtrl);
180-
181169
PyChipError pychip_DeviceController_OnNetworkCommission(chip::Controller::DeviceCommissioner * devCtrl,
182170
chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
183171
uint64_t nodeId, uint32_t setupPasscode, const uint8_t filterType,
@@ -190,7 +178,6 @@ PyChipError pychip_DeviceController_OpenCommissioningWindow(chip::Controller::De
190178
chip::NodeId nodeid, uint16_t timeout, uint32_t iteration,
191179
uint16_t discriminator, uint8_t optionInt);
192180

193-
void pychip_DeviceController_PrintDiscoveredDevices(chip::Controller::DeviceCommissioner * devCtrl);
194181
bool pychip_DeviceController_GetIPForDiscoveredDevice(chip::Controller::DeviceCommissioner * devCtrl, int idx, char * addrStr,
195182
uint32_t len);
196183

@@ -696,46 +683,6 @@ PyChipError pychip_DeviceController_Commission(chip::Controller::DeviceCommissio
696683
return ToPyChipError(devCtrl->Commission(nodeid, params));
697684
}
698685

699-
PyChipError pychip_DeviceController_DiscoverAllCommissionableNodes(chip::Controller::DeviceCommissioner * devCtrl)
700-
{
701-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kNone, static_cast<uint64_t>(0));
702-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
703-
}
704-
705-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesLongDiscriminator(chip::Controller::DeviceCommissioner * devCtrl,
706-
uint16_t long_discriminator)
707-
{
708-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kLongDiscriminator, long_discriminator);
709-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
710-
}
711-
712-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesShortDiscriminator(chip::Controller::DeviceCommissioner * devCtrl,
713-
uint16_t short_discriminator)
714-
{
715-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kShortDiscriminator, short_discriminator);
716-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
717-
}
718-
719-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesVendor(chip::Controller::DeviceCommissioner * devCtrl,
720-
uint16_t vendor)
721-
{
722-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kVendorId, vendor);
723-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
724-
}
725-
726-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesDeviceType(chip::Controller::DeviceCommissioner * devCtrl,
727-
uint16_t device_type)
728-
{
729-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kDeviceType, device_type);
730-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
731-
}
732-
733-
PyChipError pychip_DeviceController_DiscoverCommissionableNodesCommissioningEnabled(chip::Controller::DeviceCommissioner * devCtrl)
734-
{
735-
Dnssd::DiscoveryFilter filter(Dnssd::DiscoveryFilterType::kCommissioningMode);
736-
return ToPyChipError(devCtrl->DiscoverCommissionableNodes(filter));
737-
}
738-
739686
PyChipError pychip_ScriptDevicePairingDelegate_SetOpenWindowCompleteCallback(
740687
chip::Controller::ScriptDevicePairingDelegate * pairingDelegate,
741688
chip::Controller::DevicePairingDelegate_OnWindowOpenCompleteFunct callback)

‎src/controller/python/chip/ChipDeviceCtrl.py

-99
Original file line numberDiff line numberDiff line change
@@ -709,66 +709,6 @@ def DiscoverCommissionableNodes(self, filterType: discovery.FilterType = discove
709709

710710
return self.GetDiscoveredDevices()
711711

712-
def DiscoverCommissionableNodesLongDiscriminator(self, long_discriminator):
713-
''' Deprecated, use DiscoverCommissionableNodes
714-
'''
715-
self.CheckIsActive()
716-
717-
self._ChipStack.Call(
718-
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesLongDiscriminator(
719-
self.devCtrl, long_discriminator)
720-
).raise_on_error()
721-
722-
def DiscoverCommissionableNodesShortDiscriminator(self, short_discriminator):
723-
''' Deprecated, use DiscoverCommissionableNodes
724-
'''
725-
self.CheckIsActive()
726-
727-
self._ChipStack.Call(
728-
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesShortDiscriminator(
729-
self.devCtrl, short_discriminator)
730-
).raise_on_error()
731-
732-
def DiscoverCommissionableNodesVendor(self, vendor):
733-
''' Deprecated, use DiscoverCommissionableNodes
734-
'''
735-
self.CheckIsActive()
736-
737-
self._ChipStack.Call(
738-
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesVendor(
739-
self.devCtrl, vendor)
740-
).raise_on_error()
741-
742-
def DiscoverCommissionableNodesDeviceType(self, device_type):
743-
''' Deprecated, use DiscoverCommissionableNodes
744-
'''
745-
self.CheckIsActive()
746-
747-
self._ChipStack.Call(
748-
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesDeviceType(
749-
self.devCtrl, device_type)
750-
).raise_on_error()
751-
752-
def DiscoverCommissionableNodesCommissioningEnabled(self):
753-
''' Deprecated, use DiscoverCommissionableNodes
754-
'''
755-
self.CheckIsActive()
756-
757-
self._ChipStack.Call(
758-
lambda: self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesCommissioningEnabled(
759-
self.devCtrl)
760-
).raise_on_error()
761-
762-
def PrintDiscoveredDevices(self):
763-
''' Deprecated, use GetCommissionableNodes
764-
'''
765-
self.CheckIsActive()
766-
767-
self._ChipStack.Call(
768-
lambda: self._dmLib.pychip_DeviceController_PrintDiscoveredDevices(
769-
self.devCtrl)
770-
)
771-
772712
def GetDiscoveredDevices(self):
773713
def GetDevices(devCtrl):
774714
devices = []
@@ -793,16 +733,6 @@ def GetIPForDiscoveredDevice(self, idx, addrStr, length):
793733
self.devCtrl, idx, addrStr, length)
794734
)
795735

796-
def DiscoverAllCommissioning(self):
797-
''' Deprecated, use DiscoverCommissionableNodes
798-
'''
799-
self.CheckIsActive()
800-
801-
self._ChipStack.Call(
802-
lambda: self._dmLib.pychip_DeviceController_DiscoverAllCommissionableNodes(
803-
self.devCtrl)
804-
).raise_on_error()
805-
806736
class CommissioningWindowPasscode(enum.IntEnum):
807737
kOriginalSetupCode = 0,
808738
kTokenWithRandomPin = 1,
@@ -1669,26 +1599,6 @@ def _InitLib(self):
16691599
c_void_p]
16701600
self._dmLib.pychip_DeviceController_StopCommissionableDiscovery.restype = PyChipError
16711601

1672-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesLongDiscriminator.argtypes = [
1673-
c_void_p, c_uint16]
1674-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesLongDiscriminator.restype = PyChipError
1675-
1676-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesShortDiscriminator.argtypes = [
1677-
c_void_p, c_uint16]
1678-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesShortDiscriminator.restype = PyChipError
1679-
1680-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesVendor.argtypes = [
1681-
c_void_p, c_uint16]
1682-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesVendor.restype = PyChipError
1683-
1684-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesDeviceType.argtypes = [
1685-
c_void_p, c_uint16]
1686-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesDeviceType.restype = PyChipError
1687-
1688-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesCommissioningEnabled.argtypes = [
1689-
c_void_p]
1690-
self._dmLib.pychip_DeviceController_DiscoverCommissionableNodesCommissioningEnabled.restype = PyChipError
1691-
16921602
self._dmLib.pychip_DeviceController_EstablishPASESessionIP.argtypes = [
16931603
c_void_p, c_char_p, c_uint32, c_uint64, c_uint16]
16941604
self._dmLib.pychip_DeviceController_EstablishPASESessionIP.restype = PyChipError
@@ -1701,15 +1611,6 @@ def _InitLib(self):
17011611
c_void_p, c_char_p, c_uint64]
17021612
self._dmLib.pychip_DeviceController_EstablishPASESession.restype = PyChipError
17031613

1704-
self._dmLib.pychip_DeviceController_DiscoverAllCommissionableNodes.argtypes = [
1705-
c_void_p]
1706-
self._dmLib.pychip_DeviceController_DiscoverAllCommissionableNodes.restype = PyChipError
1707-
1708-
self._dmLib.pychip_DeviceController_PrintDiscoveredDevices.argtypes = [
1709-
c_void_p]
1710-
self._dmLib.pychip_DeviceController_PrintDiscoveredDevices.argtypes = [
1711-
c_void_p, _ChipDeviceController_IterateDiscoveredCommissionableNodesFunct]
1712-
17131614
self._dmLib.pychip_DeviceController_HasDiscoveredCommissionableNode.argtypes = [c_void_p]
17141615
self._dmLib.pychip_DeviceController_HasDiscoveredCommissionableNode.restype = c_bool
17151616

0 commit comments

Comments
 (0)