Skip to content

Commit feec416

Browse files
authored
Amazon MSS Over WiFi documentation (#43)
* Update documentation for MSS over WiFi
1 parent 755ffeb commit feec416

File tree

1 file changed

+86
-5
lines changed

1 file changed

+86
-5
lines changed

sld296-matter-ecosystems/amazon-ecosystem-setup.md

Lines changed: 86 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,96 @@ As part of partnership with Amazon, the following link contains information requ
1919

2020
In the context of MSS for Wi-Fi, the provisionee, or commissionee, is the device that is to be automatically set up. If you want to make your device eligible to be an MSS commissionee, you must satisfy the following:
2121

22-
1. Configure the device to beacon over Bluetooth LE (BLE) with specific fields needed for MSS for Wi-Fi (detailed below).
22+
1. Create an Amazon Developer Account
2323

24-
2. Onboard your device via the FFS developer portal by creating a Matter new device type. On the developer portal, you will manage your FFS onboarding lifecycle tasks, like managing your test devices and manufacturing data and submitting for certification.
24+
Sign up for an Amazon Developer account at https://developer.amazon.com/ if you don't already have one.
2525

26-
3. Integrate a unique barcode on your device packaging. You can also use an existing unique barcode on your packaging, such as a serial number, or MAC address.
26+
2. Create a Test Product in the Developer Console
2727

28-
4. Share your device control log data with Amazon services. Control Logs are a mechanism that allows manufacturers to provide Amazon with unique device identifiers and authentication material, such as the Matter passcode, that are critical to ensure a frictionless customer setup. The unique package barcode is associated with your device identifier through the control logs. See the Matter Control Logs section for more details.
28+
In the Amazon Developer Console, create a new test product for Matter Simple Setup (MSS).
29+
30+
Reference: https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-getting-started.html#create-your-product
31+
32+
3. Generate and Upload Control Logs
33+
34+
This step involves three parts: generating control logs, uploading them to Amazon and downloading the feedback form.
35+
36+
a. Generate Control Logs
37+
38+
Follow Option 1 in the Amazon documentation: https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-getting-started.html#generating-control-logs
39+
40+
1. Install Gradle.
41+
2. Run the following command (replace placeholder values with your actual values):
42+
43+
```bash
44+
gradle run --args="-apid APID -dsn DeviceSerialNumber -vid MatterVendorID -pid MatterProductID -p MatterDevicePasscode -a MATTER_V0 -d MatterDeviceDiscriminator -udid Base64EncodedUniqueDeviceId -pk "PublicKeyOfProduct"
45+
```
46+
47+
Command Inputs:
48+
49+
- `-apid`: Amazon-provided Advertised Product ID (Go to FFS Console → Products -> <your_product> -> Advertised Product ID)
50+
- `-dsn`: Serial Number of the Amazon Echo Device
51+
- `-vid`: Vendor ID
52+
- `-pid`: Product ID
53+
- `-p`: Matter device passcode
54+
- `-a`: Matter encryption algorithm
55+
- `-d`: Device discriminator
56+
- `-udid`: Base64-encoded Unique Device ID
57+
- `-pk`: Public key of your Amazon product (FFS Console → Products → <your_product> → Device Cryptographic Material)
58+
59+
b. Upload Control Logs to Amazon
60+
61+
- Follow the documentation steps to upload the generated control logs : https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-getting-started.html#uploading-control-logs
62+
63+
c. Download Feedback logs from Amazon
64+
65+
- Follow the steps given in : https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-getting-started.html#getting-control-log-feedback-files
66+
67+
68+
4. Pre-Register Test Devices
69+
70+
Pre-register your test devices by following the instructions here:
71+
72+
https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-getting-started.html#test-devices
73+
74+
5. Verify Amazon Account Settings
75+
76+
- Open your account settings: https://www.amazon.com/hz/mycd/preferences/myx#/home/settings/payment
77+
- Ensure Country/Region is set to United States (US).
78+
- Confirm that Simple Sign-In and Frustration-Free Setup automations are enabled.
79+
80+
81+
6. Barcode Specification
82+
83+
Integrate a unique barcode on your device packaging. You can also use an existing unique barcode on your packaging, such as a serial number, or MAC address. Refer to this link for more details:
84+
85+
https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-for-wifi-overview.html#packaging-barcode
86+
87+
7. Complete Frustration-Free Setup Certification
88+
89+
The certification process given by Amazon can be found here:
90+
91+
https://developer.amazon.com/docs/frustration-free-setup/provisionee-certification.html
92+
93+
8. Amazon ASIN Onboarding
94+
95+
For configuring the Amazon Standard Identification Number (ASIN), refer to the documentation given by Amazon here:
96+
97+
https://developer.amazon.com/docs/frustration-free-setup/asin-configuration.html
98+
99+
**Changes that should be made in the application:**
100+
101+
Amazon FFS requires use of an optional feature in Matter called additional advertising. This can be enabled in a Matter Studio project by adding the **GATT Additional Advertising** component to the project. In a GN based build, it can be included by adding the two optional build arguments to the GN build:
102+
103+
```
104+
chip_enable_additional_data_advertising=true
105+
chip_enable_rotating_device_id=true
106+
```
107+
108+
Ensure that the device advertises the fields mentioned in this link over BLE:
109+
110+
https://developer.amazon.com/docs/frustration-free-setup/matter-simple-setup-for-wifi-overview.html#ble-beaconing
29111
30-
5. Complete Frustration-Free Setup certification and Amazon ASIN onboarding. Review the certification section below for more information.
31112
32113
### Amazon Alexa MSS (Matter Simple Setup) - Thread
33114

0 commit comments

Comments
 (0)