Skip to content

[bridge-app/esp32] Add shell commands to add/remove/rename/toggle bridged endpoints. #42300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jadhavrohit924 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[bridge-app/esp32] Add shell commands to add/remove/rename/toggle bridged endpoints. #42300

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a53aa7c
[bridge-app/esp32] Add shell commands to add/remove/rename/toggle bri…
jadhavrohit924 Dec 5, 2025
9761f95
Apply copilot, gemeni reviews.
jadhavrohit924 Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
308 changes: 297 additions & 11 deletions examples/bridge-app/esp32/main/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@
#include <app/InteractionModelEngine.h>
#include <app/server/Server.h>

#if CONFIG_ENABLE_CHIP_SHELL
#include <lib/shell/Engine.h>
#include <lib/shell/commands/Help.h>
#endif // CONFIG_ENABLE_CHIP_SHELL

#if CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER
#include <platform/ESP32/ESP32FactoryDataProvider.h>
#endif // CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER
Expand Down Expand Up @@ -91,6 +96,12 @@ static Device gLight2("Light 2", "Office");
static Device gLight3("Light 3", "Kitchen");
static Device gLight4("Light 4", "Den");

// Track which lights are currently added
static bool gLight1Added = false;
static bool gLight2Added = false;
static bool gLight3Added = false;
static bool gLight4Added = false;

// (taken from chip-devices.xml)
#define DEVICE_TYPE_BRIDGED_NODE 0x0013
// (taken from lo-devices.xml)
Expand Down Expand Up @@ -361,6 +372,260 @@ const EmberAfDeviceType gAggregateNodeDeviceTypes[] = { { DEVICE_TYPE_BRIDGE, DE
const EmberAfDeviceType gBridgedOnOffDeviceTypes[] = { { DEVICE_TYPE_LO_ON_OFF_LIGHT, DEVICE_VERSION_DEFAULT },
{ DEVICE_TYPE_BRIDGED_NODE, DEVICE_VERSION_DEFAULT } };

#if CONFIG_ENABLE_CHIP_SHELL
using chip::Shell::Engine;
using chip::Shell::shell_command_t;

Engine sShellBridgeSubCommands;

static bool GetLightByNumber(int num, Device ** dev, bool ** added, DataVersion ** dataVersions)
{
switch (num)
{
case 1:
*dev = &gLight1;
*added = &gLight1Added;
*dataVersions = gLight1DataVersions;
return true;
case 2:
*dev = &gLight2;
*added = &gLight2Added;
*dataVersions = gLight2DataVersions;
return true;
case 3:
*dev = &gLight3;
*added = &gLight3Added;
*dataVersions = gLight3DataVersions;
return true;
case 4:
*dev = &gLight4;
*added = &gLight4Added;
*dataVersions = gLight4DataVersions;
return true;
default:
return false;
}
}

static CHIP_ERROR BridgeHelpHandler(int argc, char ** argv)
{
sShellBridgeSubCommands.ForEachCommand(chip::Shell::PrintCommandHelp, nullptr);
return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeAddHandler(int argc, char ** argv)
{
if (argc != 1)
{
ESP_LOGE(TAG, "Usage: bridge add <1-4>");
return CHIP_ERROR_INVALID_ARGUMENT;
}

char * end;
long lightNumLong = strtol(argv[0], &end, 10);
if (end == argv[0] || *end != '\0')
{
ESP_LOGE(TAG, "Invalid light number: %s", argv[0]);
return CHIP_ERROR_INVALID_ARGUMENT;
}
int lightNum = static_cast<int>(lightNumLong);

Device * dev;
bool * added;
DataVersion * dataVersions;

if (!GetLightByNumber(lightNum, &dev, &added, &dataVersions))
{
ESP_LOGE(TAG, "Invalid light number: %d (must be 1-4)", lightNum);
return CHIP_ERROR_INVALID_ARGUMENT;
}

if (*added)
{
ESP_LOGI(TAG, "Light %d is already added", lightNum);
return CHIP_NO_ERROR;
}

int result = AddDeviceEndpoint(dev, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(dataVersions, MATTER_ARRAY_SIZE(bridgedLightClusters)), 1);
if (result >= 0)
{
*added = true;
ESP_LOGI(TAG, "Added Light %d to endpoint %d", lightNum, dev->GetEndpointId());
}
else
{
ESP_LOGE(TAG, "Failed to add Light %d", lightNum);
return CHIP_ERROR_INTERNAL;
}

return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeRemoveHandler(int argc, char ** argv)
{
if (argc != 1)
{
ESP_LOGE(TAG, "Usage: bridge remove <1-4>");
return CHIP_ERROR_INVALID_ARGUMENT;
}

char * end;
long lightNumLong = strtol(argv[0], &end, 10);
if (end == argv[0] || *end != '\0')
{
ESP_LOGE(TAG, "Invalid light number: %s", argv[0]);
return CHIP_ERROR_INVALID_ARGUMENT;
}
int lightNum = static_cast<int>(lightNumLong);

Device * dev;
bool * added;
DataVersion * dataVersions;

if (!GetLightByNumber(lightNum, &dev, &added, &dataVersions))
{
ESP_LOGE(TAG, "Invalid light number: %d (must be 1-4)", lightNum);
return CHIP_ERROR_INVALID_ARGUMENT;
}

if (!*added)
{
ESP_LOGI(TAG, "Light %d is not currently added", lightNum);
return CHIP_NO_ERROR;
}

CHIP_ERROR err = RemoveDeviceEndpoint(dev);
if (err == CHIP_NO_ERROR)
{
*added = false;
ESP_LOGI(TAG, "Removed Light %d", lightNum);
}
else
{
ESP_LOGE(TAG, "Failed to remove Light %d", lightNum);
return err;
}

return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeListHandler(int argc, char ** argv)
{
ESP_LOGI(TAG, "Bridged devices:");

struct
{
int num;
Device * dev;
bool added;
} lights[] = {
{ 1, &gLight1, gLight1Added },
{ 2, &gLight2, gLight2Added },
{ 3, &gLight3, gLight3Added },
{ 4, &gLight4, gLight4Added },
};

for (const auto & light : lights)
{
if (light.added)
{
ESP_LOGI(TAG, " Light %d: \"%s\" (endpoint %d, %s)", light.num, light.dev->GetName(), light.dev->GetEndpointId(),
light.dev->IsOn() ? "ON" : "OFF");
}
else
{
ESP_LOGI(TAG, " Light %d: not added", light.num);
}
}

return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeRenameHandler(int argc, char ** argv)
{
// Rename all added lights to "Light Xb" (TC-BR-3)
struct
{
int num;
Device * dev;
bool added;
} lights[] = {
{ 1, &gLight1, gLight1Added },
{ 2, &gLight2, gLight2Added },
{ 3, &gLight3, gLight3Added },
{ 4, &gLight4, gLight4Added },
};

for (const auto & light : lights)
{
if (light.added)
{
char newName[16];
snprintf(newName, sizeof(newName), "Light %db", light.num);
light.dev->SetName(newName);
ESP_LOGI(TAG, "Renamed Light %d to '%s'", light.num, newName);
}
}

return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeToggleHandler(int argc, char ** argv)
{
// Toggle all added lights
struct
{
int num;
Device * dev;
bool added;
} lights[] = {
{ 1, &gLight1, gLight1Added },
{ 2, &gLight2, gLight2Added },
{ 3, &gLight3, gLight3Added },
{ 4, &gLight4, gLight4Added },
};

for (const auto & light : lights)
{
if (light.added)
{
light.dev->SetOnOff(!light.dev->IsOn());
ESP_LOGI(TAG, "Toggled Light %d: now %s", light.num, light.dev->IsOn() ? "ON" : "OFF");
}
}

return CHIP_NO_ERROR;
}

static CHIP_ERROR BridgeCommandHandler(int argc, char ** argv)
{
if (argc == 0)
{
return BridgeHelpHandler(argc, argv);
}
return sShellBridgeSubCommands.ExecCommand(argc, argv);
}

static void RegisterBridgeCommands()
{
static const shell_command_t sBridgeSubCommands[] = {
{ &BridgeHelpHandler, "help", "Usage: bridge <subcommand>" },
{ &BridgeAddHandler, "add", "Add a light: bridge add <1-4>" },
{ &BridgeRemoveHandler, "remove", "Remove a light: bridge remove <1-4>" },
{ &BridgeListHandler, "list", "List all bridged devices" },
{ &BridgeRenameHandler, "rename", "Rename all lights to 'Light Xb'" },
{ &BridgeToggleHandler, "toggle", "Toggle all lights on/off" },
};

static const shell_command_t sBridgeCommand = { &BridgeCommandHandler, "bridge",
"Bridge commands. Usage: bridge <subcommand>" };

sShellBridgeSubCommands.RegisterCommands(sBridgeSubCommands, MATTER_ARRAY_SIZE(sBridgeSubCommands));
Engine::Root().RegisterCommands(&sBridgeCommand, 1);
}
#endif // CONFIG_ENABLE_CHIP_SHELL

static void InitServer(intptr_t context)
{
PrintOnboardingCodes(chip::RendezvousInformationFlags(CONFIG_RENDEZVOUS_MODE));
Expand All @@ -382,23 +647,43 @@ static void InitServer(intptr_t context)
emberAfSetDeviceTypeList(1, Span<const EmberAfDeviceType>(gAggregateNodeDeviceTypes));

// Add lights 1..3 --> will be mapped to ZCL endpoints 3, 4, 5
AddDeviceEndpoint(&gLight1, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight1DataVersions), 1);
AddDeviceEndpoint(&gLight2, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight2DataVersions), 1);
AddDeviceEndpoint(&gLight3, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight3DataVersions), 1);
if (AddDeviceEndpoint(&gLight1, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight1DataVersions), 1) >= 0)
{
gLight1Added = true;
}

if (AddDeviceEndpoint(&gLight2, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight2DataVersions), 1) >= 0)
{
gLight2Added = true;
}

if (AddDeviceEndpoint(&gLight3, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight3DataVersions), 1) >= 0)
{
gLight3Added = true;
}

// Remove Light 2 -- Lights 1 & 3 will remain mapped to endpoints 3 & 5
RemoveDeviceEndpoint(&gLight2);
if (RemoveDeviceEndpoint(&gLight2) == CHIP_NO_ERROR)
{
gLight2Added = false;
}

// Add Light 4 -- > will be mapped to ZCL endpoint 6
AddDeviceEndpoint(&gLight4, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight4DataVersions), 1);
if (AddDeviceEndpoint(&gLight4, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight4DataVersions), 1) >= 0)
{
gLight4Added = true;
}

// Re-add Light 2 -- > will be mapped to ZCL endpoint 7
AddDeviceEndpoint(&gLight2, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight2DataVersions), 1);
if (AddDeviceEndpoint(&gLight2, &bridgedLightEndpoint, Span<const EmberAfDeviceType>(gBridgedOnOffDeviceTypes),
Span<DataVersion>(gLight2DataVersions), 1) >= 0)
{
gLight2Added = true;
}
}

void emberAfActionsClusterInitCallback(EndpointId endpoint)
Expand Down Expand Up @@ -436,6 +721,7 @@ extern "C" void app_main()
chip::RegisterOpenThreadCliCommands();
#endif
chip::LaunchShell();
RegisterBridgeCommands();
#endif

CHIP_ERROR chip_err = CHIP_NO_ERROR;
Expand Down
Loading