Skip to content

Commit bbf5f75

Browse files
chrisdecenzorestyled-io[bot]restyled-commits
authored
TV: Add sample app tools for triggering client commands (project-chip#32365)
* Add sample app tools for triggering test cases * Fix locking when obtaining passcode from content app * Fix messages test case * fix ci * Restyle TV: Add sample app tools for triggering client commands (project-chip#32366) * Restyled by whitespace * Restyled by google-java-format --------- Co-authored-by: Restyled.io <commits@restyled.io> * fix ci, address comments * fix ci * address comments * address comments --------- Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <commits@restyled.io>
1 parent bd9e4c2 commit bbf5f75

File tree

19 files changed

+416
-19
lines changed

19 files changed

+416
-19
lines changed

‎examples/tv-app/android/App/platform-app/src/main/java/com/matter/tv/server/fragments/TerminalFragment.java

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ public class TerminalFragment extends Fragment {
2424
private static String TERMINAL_INSTRUCTIONS =
2525
"add <vid> [<pid>] Add app with given vendor ID [1, 2, 9050]. Usage: add 9050\r\n"
2626
+ "remove <endpoint> Remove app at given endpoint [6, 7, etc]. Usage: remove 6\r\n"
27+
+ "appobserver <appendpoint> <clientnodeindex> <data> <hint> Send app observer command to client node of the given app endpoint. Usage: appobserver 4 0 data hint\r\n"
28+
+ "printclients <appendpoint> Print list of client nodes for the given app endpoint. Usage: printclients 4\r\n"
2729
+ "setpin <endpoint> <pincode> Set pincode for app with given endpoint ID. Usage: setpin 6 34567890\r\n"
2830
+ "commission <udc-entry> Commission given udc-entry using given pincode from corresponding app. Usage:"
2931
+ "commission 0\r\n"

‎examples/tv-app/android/java/AppImpl.cpp

+13-6
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,7 @@ ContentApp * ContentAppFactoryImpl::LoadContentApp(const CatalogVendorApp & vend
324324
ChipLogProgress(DeviceLayer, " Looking next=%s ", app->GetApplicationBasicDelegate()->GetCatalogVendorApp()->applicationId);
325325
if (app->GetApplicationBasicDelegate()->GetCatalogVendorApp()->Matches(vendorApp))
326326
{
327+
// need to think about loading apk here?
327328
ContentAppPlatform::GetInstance().AddContentApp(app, &contentAppEndpoint, Span<DataVersion>(gDataVersions[i]),
328329
Span<const EmberAfDeviceType>(gContentAppDeviceType));
329330
return app;
@@ -422,19 +423,25 @@ std::list<ClusterId> ContentAppFactoryImpl::GetAllowedClusterListForStaticEndpoi
422423
ChipLogProgress(DeviceLayer,
423424
"ContentAppFactoryImpl GetAllowedClusterListForStaticEndpoint priviledged vendor accessible clusters "
424425
"being returned.");
425-
return { chip::app::Clusters::Descriptor::Id, chip::app::Clusters::OnOff::Id,
426-
chip::app::Clusters::WakeOnLan::Id, chip::app::Clusters::MediaPlayback::Id,
427-
chip::app::Clusters::LowPower::Id, chip::app::Clusters::KeypadInput::Id,
428-
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id,
429-
chip::app::Clusters::ApplicationLauncher::Id };
426+
return { chip::app::Clusters::Descriptor::Id,
427+
chip::app::Clusters::OnOff::Id,
428+
chip::app::Clusters::WakeOnLan::Id,
429+
chip::app::Clusters::MediaPlayback::Id,
430+
chip::app::Clusters::LowPower::Id,
431+
chip::app::Clusters::KeypadInput::Id,
432+
chip::app::Clusters::ContentLauncher::Id,
433+
chip::app::Clusters::AudioOutput::Id,
434+
chip::app::Clusters::ApplicationLauncher::Id,
435+
chip::app::Clusters::Messages::Id };
430436
}
431437
ChipLogProgress(
432438
DeviceLayer,
433439
"ContentAppFactoryImpl GetAllowedClusterListForStaticEndpoint operator vendor accessible clusters being returned.");
434440
return { chip::app::Clusters::Descriptor::Id, chip::app::Clusters::OnOff::Id,
435441
chip::app::Clusters::WakeOnLan::Id, chip::app::Clusters::MediaPlayback::Id,
436442
chip::app::Clusters::LowPower::Id, chip::app::Clusters::KeypadInput::Id,
437-
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id };
443+
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id,
444+
chip::app::Clusters::Messages::Id };
438445
}
439446
return {};
440447
}

‎examples/tv-app/android/java/src/com/matter/tv/server/tvapp/MessagesManagerStub.java

-7
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,6 @@ public class MessagesManagerStub implements MessagesManager {
3131
public MessagesManagerStub(int endpoint) {
3232
this.endpoint = endpoint;
3333
Log.d(TAG, "MessagesManagerStub: at " + this.endpoint);
34-
35-
HashMap<Long, String> responseOptions = new HashMap<Long, String>();
36-
responseOptions.put(new Long(1), "Yes");
37-
responseOptions.put(new Long(2), "No");
38-
presentMessages(
39-
"31323334353637383930313233343536", 1, 1, 30, 60000, "TestMessage", responseOptions);
40-
Log.d(TAG, "MessagesManagerStub: added dummy message");
4134
}
4235

4336
@Override

‎examples/tv-app/tv-common/shell/AppTvShellCommands.cpp

+62
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,11 @@ static CHIP_ERROR PrintAllCommands()
193193
#if CHIP_DEVICE_CONFIG_APP_PLATFORM_ENABLED
194194
streamer_printf(sout, " add <vid> [<pid>] Add app with given vendor ID [1, 2, 9050]. Usage: app add 9050\r\n");
195195
streamer_printf(sout, " remove <endpoint> Remove app at given endpoint [6, 7, etc]. Usage: app remove 6\r\n");
196+
streamer_printf(sout,
197+
" appobserver <appendpoint> <clientnodeindex> <data> <hint> Send app observer command to client node of "
198+
"the given app endpoint. Usage: appobserver 4 0 data hint\r\n");
199+
streamer_printf(
200+
sout, " printclients <appendpoint> Print list of client nodes for the given app endpoint. Usage: printclients 4\r\n");
196201
streamer_printf(
197202
sout, " setpin <endpoint> <pincode> Set pincode for app with given endpoint ID. Usage: app setpin 6 34567890\r\n");
198203
streamer_printf(sout,
@@ -277,6 +282,63 @@ static CHIP_ERROR AppPlatformHandler(int argc, char ** argv)
277282

278283
return CHIP_NO_ERROR;
279284
}
285+
else if (strcmp(argv[0], "printclients") == 0)
286+
{
287+
if (argc < 2)
288+
{
289+
return PrintAllCommands();
290+
}
291+
char * eptr;
292+
293+
uint16_t endpoint = (uint16_t) strtol(argv[1], &eptr, 10);
294+
ContentApp * app = ContentAppPlatform::GetInstance().GetContentApp(endpoint);
295+
if (app == nullptr)
296+
{
297+
ChipLogProgress(DeviceLayer, "app not found");
298+
return CHIP_ERROR_BAD_REQUEST;
299+
}
300+
uint8_t count = app->GetClientNodeCount();
301+
ChipLogProgress(DeviceLayer, " node count: %d", count);
302+
for (uint8_t i = 0; i < count; i++)
303+
{
304+
NodeId node = app->GetClientNode(i);
305+
ChipLogProgress(DeviceLayer, " node[%d] " ChipLogFormatX64, i, ChipLogValueX64(node));
306+
}
307+
}
308+
#if CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
309+
else if (strcmp(argv[0], "appobserver") == 0)
310+
{
311+
if (argc < 5)
312+
{
313+
return PrintAllCommands();
314+
}
315+
char * eptr;
316+
317+
uint16_t endpoint = (uint16_t) strtol(argv[1], &eptr, 10);
318+
ContentApp * app = ContentAppPlatform::GetInstance().GetContentApp(endpoint);
319+
if (app == nullptr)
320+
{
321+
ChipLogProgress(DeviceLayer, "app not found");
322+
return CHIP_ERROR_BAD_REQUEST;
323+
}
324+
uint8_t clientNodeIndex = (uint8_t) strtol(argv[2], &eptr, 10);
325+
if (clientNodeIndex >= app->GetClientNodeCount())
326+
{
327+
ChipLogProgress(DeviceLayer, "illegal client node index");
328+
return CHIP_ERROR_BAD_REQUEST;
329+
}
330+
NodeId clientNode = app->GetClientNode(clientNodeIndex);
331+
332+
char * data = argv[3];
333+
char * encodingHint = argv[4];
334+
335+
app->SendAppObserverCommand(GetDeviceCommissioner(), clientNode, data, encodingHint);
336+
337+
ChipLogProgress(DeviceLayer, "sent appobserver command");
338+
339+
return CHIP_NO_ERROR;
340+
}
341+
#endif // CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
280342
else if (strcmp(argv[0], "setpin") == 0)
281343
{
282344
if (argc < 3)

‎examples/tv-app/tv-common/src/AppTv.cpp

+12-6
Original file line numberDiff line numberDiff line change
@@ -549,19 +549,25 @@ std::list<ClusterId> ContentAppFactoryImpl::GetAllowedClusterListForStaticEndpoi
549549
ChipLogProgress(DeviceLayer,
550550
"ContentAppFactoryImpl GetAllowedClusterListForStaticEndpoint priviledged vendor accessible clusters "
551551
"being returned.");
552-
return { chip::app::Clusters::Descriptor::Id, chip::app::Clusters::OnOff::Id,
553-
chip::app::Clusters::WakeOnLan::Id, chip::app::Clusters::MediaPlayback::Id,
554-
chip::app::Clusters::LowPower::Id, chip::app::Clusters::KeypadInput::Id,
555-
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id,
556-
chip::app::Clusters::ApplicationLauncher::Id };
552+
return { chip::app::Clusters::Descriptor::Id,
553+
chip::app::Clusters::OnOff::Id,
554+
chip::app::Clusters::WakeOnLan::Id,
555+
chip::app::Clusters::MediaPlayback::Id,
556+
chip::app::Clusters::LowPower::Id,
557+
chip::app::Clusters::KeypadInput::Id,
558+
chip::app::Clusters::ContentLauncher::Id,
559+
chip::app::Clusters::AudioOutput::Id,
560+
chip::app::Clusters::ApplicationLauncher::Id,
561+
chip::app::Clusters::Messages::Id }; // TODO: messages?
557562
}
558563
ChipLogProgress(
559564
DeviceLayer,
560565
"ContentAppFactoryImpl GetAllowedClusterListForStaticEndpoint operator vendor accessible clusters being returned.");
561566
return { chip::app::Clusters::Descriptor::Id, chip::app::Clusters::OnOff::Id,
562567
chip::app::Clusters::WakeOnLan::Id, chip::app::Clusters::MediaPlayback::Id,
563568
chip::app::Clusters::LowPower::Id, chip::app::Clusters::KeypadInput::Id,
564-
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id };
569+
chip::app::Clusters::ContentLauncher::Id, chip::app::Clusters::AudioOutput::Id,
570+
chip::app::Clusters::Messages::Id };
565571
}
566572
return {};
567573
}

‎examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/CertTestFragment.java

+7
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,13 @@ private void runCertTests(Activity activity) {
309309
kContentApp, successCallbackInteger, failureCallback);
310310
});
311311

312+
runAndWait(
313+
"messages_presentMessages",
314+
successFailureCallback,
315+
() -> {
316+
tvCastingApp.messages_presentMessages(kTVApp, "CastingAppTestMessage", callback);
317+
});
318+
312319
runAndWait(
313320
"mediaPlayback_subscribeToCurrentState",
314321
successFailureCallback,

‎examples/tv-casting-app/android/App/app/src/main/jni/com/chip/casting/TvCastingApp.java

+3
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,9 @@ public native boolean applicationBasic_readApplicationVersion(
599599

600600
public native boolean onOff_toggle(ContentApp contentApp, Object responseHandler);
601601

602+
public native boolean messages_presentMessages(
603+
ContentApp contentApp, String messageText, Object responseHandler);
604+
602605
static {
603606
System.loadLibrary("TvCastingApp");
604607
}

‎examples/tv-casting-app/android/App/app/src/main/jni/cpp/Constants.h

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ enum MediaCommandName
3737
MediaPlayback_Seek,
3838
MediaPlayback_SkipForward,
3939
MediaPlayback_SkipBackward,
40+
Messages_PresentMessagesRequest,
4041
ApplicationLauncher_LaunchApp,
4142
ApplicationLauncher_StopApp,
4243
ApplicationLauncher_HideApp,

‎examples/tv-casting-app/android/App/app/src/main/jni/cpp/TvCastingApp-JNI.cpp

+30
Original file line numberDiff line numberDiff line change
@@ -865,6 +865,36 @@ JNI_METHOD(jboolean, onOff_1toggle)
865865
return (err == CHIP_NO_ERROR);
866866
}
867867

868+
JNI_METHOD(jboolean, messages_1presentMessages)
869+
(JNIEnv * env, jobject, jobject contentApp, jstring messageText, jobject jResponseHandler)
870+
{
871+
chip::DeviceLayer::StackLock lock;
872+
873+
ChipLogProgress(AppServer, "JNI_METHOD messages_presentMessages called");
874+
const char * nativeMessageText = env->GetStringUTFChars(messageText, 0);
875+
876+
TargetEndpointInfo endpoint;
877+
CHIP_ERROR err = convertJContentAppToTargetEndpointInfo(contentApp, endpoint);
878+
VerifyOrExit(err == CHIP_NO_ERROR,
879+
ChipLogError(AppServer, "Conversion from jobject contentApp to TargetEndpointInfo * failed: %" CHIP_ERROR_FORMAT,
880+
err.Format()));
881+
882+
err = TvCastingAppJNIMgr().getMediaCommandResponseHandler(Messages_PresentMessagesRequest).SetUp(env, jResponseHandler);
883+
VerifyOrExit(CHIP_NO_ERROR == err,
884+
ChipLogError(AppServer, "MatterCallbackHandlerJNI.SetUp failed %" CHIP_ERROR_FORMAT, err.Format()));
885+
886+
err = CastingServer::GetInstance()->Messages_PresentMessagesRequest(&endpoint, nativeMessageText, [](CHIP_ERROR err) {
887+
TvCastingAppJNIMgr().getMediaCommandResponseHandler(Messages_PresentMessagesRequest).Handle(err);
888+
});
889+
VerifyOrExit(CHIP_NO_ERROR == err,
890+
ChipLogError(AppServer, "CastingServer.Messages_PresentMessagesRequest failed %" CHIP_ERROR_FORMAT, err.Format()));
891+
892+
env->ReleaseStringUTFChars(messageText, nativeMessageText);
893+
894+
exit:
895+
return (err == CHIP_NO_ERROR);
896+
}
897+
868898
JNI_METHOD(jboolean, mediaPlayback_1play)
869899
(JNIEnv * env, jobject, jobject contentApp, jobject jResponseHandler)
870900
{

‎examples/tv-casting-app/tv-casting-common/BUILD.gn

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ chip_data_model("tv-casting-common") {
6868
"include/MediaPlayback.h",
6969
"include/MediaReadBase.h",
7070
"include/MediaSubscriptionBase.h",
71+
"include/Messages.h",
7172
"include/OnOff.h",
7273
"include/PersistenceManager.h",
7374
"include/TargetEndpointInfo.h",
@@ -83,6 +84,7 @@ chip_data_model("tv-casting-common") {
8384
"src/KeypadInput.cpp",
8485
"src/LevelControl.cpp",
8586
"src/MediaPlayback.cpp",
87+
"src/Messages.cpp",
8688
"src/OnOff.cpp",
8789
"src/PersistenceManager.cpp",
8890
"src/TargetEndpointInfo.cpp",

‎examples/tv-casting-app/tv-casting-common/include/CastingServer.h

+12
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
#include "KeypadInput.h"
2828
#include "LevelControl.h"
2929
#include "MediaPlayback.h"
30+
#include "Messages.h"
3031
#include "OnOff.h"
3132
#include "PersistenceManager.h"
3233
#include "TargetEndpointInfo.h"
@@ -186,6 +187,12 @@ class CastingServer : public AppDelegate
186187
CHIP_ERROR OnOff_Off(TargetEndpointInfo * endpoint, std::function<void(CHIP_ERROR)> responseCallback);
187188
CHIP_ERROR OnOff_Toggle(TargetEndpointInfo * endpoint, std::function<void(CHIP_ERROR)> responseCallback);
188189

190+
/**
191+
* @brief Messages cluster
192+
*/
193+
CHIP_ERROR Messages_PresentMessagesRequest(TargetEndpointInfo * endpoint, const char * messageText,
194+
std::function<void(CHIP_ERROR)> responseCallback);
195+
189196
/**
190197
* @brief Media Playback cluster
191198
*/
@@ -510,6 +517,11 @@ class CastingServer : public AppDelegate
510517
OffCommand mOffCommand;
511518
ToggleCommand mToggleCommand;
512519

520+
/**
521+
* @brief OnOff cluster
522+
*/
523+
PresentMessagesRequestCommand mPresentMessagesRequestCommand;
524+
513525
/**
514526
* @brief Media Playback cluster
515527
*/

‎examples/tv-casting-app/tv-casting-common/include/Messages.h

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
*
3+
* Copyright (c) 2024 Project CHIP Authors
4+
* All rights reserved.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "MediaCommandBase.h"
20+
#include "MediaSubscriptionBase.h"
21+
22+
#include <controller/CHIPCluster.h>
23+
#include <functional>
24+
25+
#include <app-common/zap-generated/cluster-objects.h>
26+
27+
// COMMAND CLASSES
28+
class PresentMessagesRequestCommand : public MediaCommandBase<chip::app::Clusters::Messages::Commands::PresentMessagesRequest::Type,
29+
chip::app::DataModel::NullObjectType>
30+
{
31+
public:
32+
PresentMessagesRequestCommand() : MediaCommandBase(chip::app::Clusters::Messages::Id) {}
33+
34+
CHIP_ERROR
35+
Invoke(const char * messageText, std::function<void(CHIP_ERROR)> responseCallback);
36+
};

‎examples/tv-casting-app/tv-casting-common/src/CastingServer.cpp

+10
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,16 @@ CHIP_ERROR CastingServer::OnOff_Toggle(TargetEndpointInfo * endpoint, std::funct
869869
return mToggleCommand.Invoke(responseCallback);
870870
}
871871

872+
/**
873+
* @brief Messages cluster
874+
*/
875+
CHIP_ERROR CastingServer::Messages_PresentMessagesRequest(TargetEndpointInfo * endpoint, const char * messageText,
876+
std::function<void(CHIP_ERROR)> responseCallback)
877+
{
878+
ReturnErrorOnFailure(mPresentMessagesRequestCommand.SetTarget(mActiveTargetVideoPlayerInfo, endpoint->GetEndpointId()));
879+
return mPresentMessagesRequestCommand.Invoke(messageText, responseCallback);
880+
}
881+
872882
/**
873883
* @brief Media Playback cluster
874884
*/

‎examples/tv-casting-app/tv-casting-common/src/Messages.cpp

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
*
3+
* Copyright (c) 2024 Project CHIP Authors
4+
* All rights reserved.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "Messages.h"
20+
21+
using namespace chip;
22+
using namespace chip::app;
23+
using namespace chip::app::Clusters;
24+
using namespace chip::app::Clusters::Messages;
25+
26+
CHIP_ERROR PresentMessagesRequestCommand::Invoke(const char * messageText, std::function<void(CHIP_ERROR)> responseCallback)
27+
{
28+
Messages::Commands::PresentMessagesRequest::Type request;
29+
uint8_t buf[16] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5 };
30+
31+
request.messageID = ByteSpan(buf, sizeof(buf));
32+
request.messageText = CharSpan::fromCharString(messageText);
33+
request.priority = MessagePriorityEnum(static_cast<uint8_t>(0));
34+
request.startTime = DataModel::Nullable<uint32_t>(static_cast<uint32_t>(0));
35+
request.duration = DataModel::Nullable<uint64_t>(static_cast<uint64_t>(60 * 1000));
36+
37+
return MediaCommandBase::Invoke(request, responseCallback);
38+
}

0 commit comments

Comments
 (0)