Skip to content

Commit 922dea6

Browse files
committed
General availability
1 parent dbff06b commit 922dea6

File tree

120 files changed

+4490
-1481
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+4490
-1481
lines changed
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# Manage applications on an AWS Panorama Appliance<a name="appliance-applications"></a>
22

3-
An application is a combination of Lambda functions, models, and configuration\. From the **Appliances** page in the AWS Panorama console, you can modify an application's configuration and deploy published versions to the AWS Panorama Appliance\.
3+
An application is a combination of code, models, and configuration\. From the **Devices** page in the AWS Panorama console, you can manage applications on the appliance\.
44

55
**To manage applications on an AWS Panorama Appliance**
66

7-
1. Open the AWS Panorama console [Appliances page](https://console.aws.amazon.com/panorama/home#appliances)\.
7+
1. Open the AWS Panorama console [Devices page](https://console.aws.amazon.com/panorama/home#devices)\.
88

99
1. Choose an appliance\.
1010

11-
1. Choose the **Applications** tab\.
11+
The **Deployed applications** page shows applications that have been deployed to the appliance\.
1212

13-
The **Applications** page shows applications that have been deployed to the appliance\.
14-
15-
Use the options on this page to remove deployed applications from the appliance\. To monitor deployments, choose **Application operations**\.
13+
Use the options on this page to remove deployed applications from the appliance, or replace a running application with a new version\. You can also clone an application \(running or deleted\) to deploy a new copy of it\.

docs-source/appliance-buttons.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,41 @@ The AWS Panorama Appliance has two LED lights above the power button that indica
44

55
![\[\]](http://docs.aws.amazon.com/panorama/latest/dev/images/appliance-leds.png)
66

7+
## Status light<a name="appliance-buttons-status"></a>
8+
79
The LEDs change color and blink to indicate status\. A slow blink is once every three seconds\. A fast blink is once per second\.
810

911
**Status LED states**
1012
+ **Fast blinking green** – The appliance is booting up\.
1113
+ **Solid green** – The appliance is operating normally\.
12-
+ **Slow blinking blue** – The appliance is copying configuration files and attempting to register with AWS IoT Greengrass\.
14+
+ **Slow blinking blue** – The appliance is copying configuration files and attempting to register with AWS IoT\.
1315
+ **Fast blinking red** – The appliance encountered an error during startup or is overheated\.
1416
+ **Slow blinking orange** – The appliance is restoring the latest software image\.
1517
+ **Fast blinking orange** – The appliance is restoring the factory software image\.
1618

17-
To reset the device, use the following button combinations\. A short press is 1 second\. A long press is 5 seconds\. For operations that require multiple buttons, press and hold both buttons simultaneously\.
18-
19-
**Reset operations**
20-
+ **To shut down the appliance** – Short press power\. Starts a shutdown sequence that takes about 10 seconds\.
21-
+ **To restore the latest software image** – Shut down the appliance, and then short press reset\.
22-
+ **To restore the factory software image** – Shut down the appliance, and then long press reset\.
23-
+ **To restore the factory software image and delete all configuration files and applications** – Shut down the appliance, and then long press power and reset\.
19+
## Network light<a name="appliance-buttons-network"></a>
2420

2521
The network LED has the following states:
2622

2723
**Network LED states**
2824
+ **Solid green** – An Ethernet cable is connected\.
2925
+ **Blinking green** – The appliance is communicating over the network\.
3026
+ **Solid red** – An Ethernet cable is not connected\.
31-
+ **Solid blue** – An Ethernet cable is not connected, but Wi\-Fi is enabled\.
27+
+ **Solid blue** – An Ethernet cable is not connected, but Wi\-Fi is enabled\.
28+
29+
## Power and reset buttons<a name="appliance-buttons-reset"></a>
30+
31+
To power down the appliance, press and hold the power button for 1 second\. The shutdown sequence takes about 10 seconds\.
32+
33+
To reset the appliance, use the following button combinations\. A short press is 1 second\. A long press is 5 seconds\. To start a reset operation, the appliance must be powered down\. For operations that require multiple buttons, press and hold both buttons simultaneously\.
34+
35+
**Reset operations**
36+
+ **Full reset** – Long press power and reset\.
37+
38+
Restores the minimum software version and deletes all configuration files and applications\.
39+
+ **Restore latest software version** – Short press reset\.
40+
41+
Reapplies the latest software update to the appliance\.
42+
+ **Restore minimum software version** – Long press reset\.
43+
44+
Reapplies the latest required software update to the appliance\.

docs-source/appliance-cameras.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
1-
# Managing camera streams for an AWS Panorama Appliance<a name="appliance-cameras"></a>
1+
# Managing camera streams in AWS Panorama<a name="appliance-cameras"></a>
22

3-
To register video streams as data sources for your application, use the AWS Panorama console\. An application can process multiple streams simultaneously and multiple appliances can connect to the same stream\. The AWS Panorama Appliance can find camera streams automatically, or you can manually specify them\.
3+
To register video streams as data sources for your application, use the AWS Panorama console\. An application can process multiple streams simultaneously and multiple appliances can connect to the same stream\.
44

55
**Important**
6-
The AWS Panorama Appliance can connect to any camera stream that is routable from the local network it connects to\. To secure your video streams, configure your network to allow only RTSP traffic locally\. For more information, see [Security in AWS Panorama](panorama-security.md)\.
6+
An application can connect to any camera stream that is routable from the local network it connects to\. To secure your video streams, configure your network to allow only RTSP traffic locally\. For more information, see [Security in AWS Panorama](panorama-security.md)\.
77

8-
**To add a camera stream to the AWS Panorama Appliance**
8+
**To register a camera stream**
99

10-
1. Open the AWS Panorama console [Appliances page](https://console.aws.amazon.com/panorama/home#appliances)\.
10+
1. Open the AWS Panorama console [Data sources page](https://console.aws.amazon.com/panorama/home#data-sources)\.
1111

12-
1. Choose an appliance\.
13-
14-
1. Choose **Inputs**\.
12+
1. Choose **Add data source**\.
13+
![\[\]](http://docs.aws.amazon.com/panorama/latest/dev/images/setup-addstream.png)
1514

16-
1. Choose **Add camera**\.
17-
![\[\]](http://docs.aws.amazon.com/panorama/latest/dev/images/console-device-addstream.png)
15+
1. Configure the following settings\.
1816

19-
1. Choose a connection mode\. Try **Automatic** first\. If it doesn't find your camera stream, use **Manual**\.
20-
+ **Automatic** – The AWS Panorama Appliance discovers cameras on the local network\. Choose a camera and then choose a stream to add\. If the camera has multiple streams, repeat the process to add additional streams\.
21-
+ **Manual** – Enter the IP address of the camera and the RTSP URL of a stream\.
17+
****
18+
+ **Name** – A name for the camera stream\.
19+
+ **Description** – A short description of the camera, its location, or other details\.
20+
+ **RTSP URL** – A URL that specifies the camera's IP address and the path to the stream\. For example, `rtsp://192.168.0.77/live/mpeg4/`
21+
+ **Credentials** – If the camera stream is password protected, specify the username and password\.
2222

23-
Both workflows support password\-protected cameras\.
24-
25-
1. Choose **Confirm**\.
23+
1. Choose **Save**\.
2624

2725
For a list of cameras that are compatible with the AWS Panorama Appliance, see [Supported computer vision models and cameras](gettingstarted-compatibility.md)\.
2826

2927
## Removing a stream<a name="appliance-cameras-remove"></a>
3028

31-
To deregister a video stream, remove it from the appliance's inputs\.
29+
You can delete a camera stream in the AWS Panorama console\.
3230

3331
**To remove a camera stream**
3432

35-
1. Open the AWS Panorama console [Appliances page](https://console.aws.amazon.com/panorama/home#appliances)\.
33+
1. Open the AWS Panorama console [Devices page](https://console.aws.amazon.com/panorama/home#devices)\.
3634

3735
1. Choose an appliance\.
3836

3937
1. Choose **Camera streams**\.
4038

4139
1. Choose a stream\.
4240

43-
1. Choose **Remove stream**\.
41+
1. Choose **Remove stream**\.
42+
43+
Removing a camera stream from the service does not stop running applications or delete camera credentials from Secrets Manager\. To delete secrets, use the [Secrets Manager console](https://console.aws.amazon.com/secretsmanager/home#!/listSecrets)\.

docs-source/appliance-devkit.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

docs-source/appliance-manage.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,28 @@ To set up an appliance, follow the instructions in the [getting started tutorial
1212

1313
You view and deploy software updates for the AWS Panorama Appliance in the AWS Panorama console\. Updates can be required or optional\. When a required update is available, the console prompts you to apply it\. You can apply optional updates on the appliance **Settings** page\.
1414

15-
**Important**
16-
When you update the appliance software, all data on the device is overwritten except for the contents of the `/data` directory\. This directory includes your application data and logs\. You can also use `/data` to store scripts and other files\. For more information, see [The AWS Panorama Appliance Developer Kit](appliance-devkit.md)\.
17-
1815
**To update the appliance software**
1916

20-
1. Open the AWS Panorama console [Appliances page](https://console.aws.amazon.com/panorama/home#appliances)\.
17+
1. Open the AWS Panorama console [Devices page](https://console.aws.amazon.com/panorama/home#devices)\.
2118

2219
1. Choose an appliance\.
2320

2421
1. Choose **Settings**
2522

26-
1. Under **System software**, choose **Install version**\.
23+
1. Under **System software**, choose **Install software update**\.
24+
![\[\]](http://docs.aws.amazon.com/panorama/latest/dev/images/setup-upgrade.png)
25+
26+
1. Choose a new version and then choose **Install**\.
2727

2828
## Deregister an appliance<a name="appliance-manage-delete"></a>
2929

30-
If you are done working with the AWS Panorama Appliance, you can use the AWS Panorama console to deregister it and delete the associated AWS IoT and AWS IoT Greengrass resources\.
30+
If you are done working with the AWS Panorama Appliance, you can use the AWS Panorama console to deregister it and delete the associated AWS IoT resources\.
3131

32-
When you delete an appliance from the AWS Panorama service, data on the appliance is not deleted automatically\. This data includes applications, camera information, the appliance certificate, network configuration, and logs\. You can remove [applications](appliance-applications.md) and [cameras](appliance-cameras.md#appliance-cameras-remove) from the device prior to deregistering it, or reset the device to its factory state\.
32+
When you delete an appliance from the AWS Panorama service, data on the appliance is not deleted automatically\. This data includes applications, camera information, the appliance certificate, network configuration, and logs\. You can remove [applications](appliance-applications.md) from the device prior to deregistering it, or reset the device to its factory state\.
3333

3434
**To delete an appliance**
3535

36-
1. Open the AWS Panorama console [Appliances page](https://console.aws.amazon.com/panorama/home#appliances)\.
36+
1. Open the AWS Panorama console [Devices page](https://console.aws.amazon.com/panorama/home#devices)\.
3737

3838
1. Choose the appliance\.
3939

docs-source/applications-awssdk.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
You can use the AWS SDK for Python \(Boto\) to call AWS services from your application code\. For example, if your model detects something out of the ordinary, you could post metrics to Amazon CloudWatch, send an notification with Amazon SNS, save an image to Amazon S3, or invoke a Lambda function for further processing\. Most AWS services have a public API that you can use with the AWS SDK\.
44

5-
The appliance does not have permission to access all AWS services by default\. To grant it permission, add the API actions that it uses to the appliance's role \([AWSPanoramaGreengrassGroupRole](permissions-services.md)\)\. You create this role when you first use the AWS Panorama console\. It comes with limited permission to use Amazon S3 CloudWatch, and Amazon CloudWatch Logs\.
5+
The appliance does not have permission to access any AWS services by default\. To grant it permission, [create a role for the application](permissions-application.md), and assign it to the application instance during deployment\.
66

77
**Topics**
88
+ [Using Amazon S3](#applications-awssdk-s3)
@@ -20,8 +20,6 @@ s3_clients3.upload_file(data_file,
2020
os.path.basename(data_file))
2121
```
2222

23-
The appliance has permission to access buckets that include `aws-panorama` in the name\. To grant it additional permission, you can modify the appliance's role \([AWSPanoramaGreengrassGroupRole](permissions-services.md)\)\.
24-
2523
## Using the AWS IoT MQTT topic<a name="monitoring-messagestream"></a>
2624

2725
You can use the SDK for Python \(Boto3\) to send messages to an [MQTT topic](https://docs.aws.amazon.com/iot/latest/developerguide/topics.html) in AWS IoT\. In the following example, the application posts to a topic named after the appliance's *thing name*, which you can find in [AWS IoT console](https://console.aws.amazon.com/iot/home#/thinghub)\.

0 commit comments

Comments
 (0)