Greengrass Quick Start

Greengrass Quick Start

Get your first Greengrass Device connected and sending telemetry in under 15 minutes. This guide walks you through the entire process from Device registration to live data — no coding required using pre-built demo components.

Prerequisites

Before you begin, ensure you have:

/IOTCONNECT™ Account: Active subscription with Greengrass Device module access.

Edge Device: A Linux-based Device with network connectivity (Raspberry Pi 4/5, x86 PC, or STM32MP board).

SSH access: Terminal access to your target Device for running installer scripts.

File transfer: Ability to copy files to your Device (SCP, USB, or direct download).

Runtime-specific requirements:

Nucleus Classic Nucleus Lite
Java 11 or higher Basic Linux (no Java needed)
Python 3.9+ with venv Python 3 (varies by board)
512MB+ RAM 64MB+ RAM
2GB+ disk space 256MB+ disk space

Step 1: Create a Template

Purpose: A template defines what telemetry your Device will send and what commands it can receive. You must create a template before creating a Device.

Steps:

1. Navigate to Devices → Greengrass Device from the left sidebar.

2. Click the Templates tab at the bottom of the page.

3. Click Create Template.

4. Fill in the fields:

Template name: A descriptive name (e.g., “Environmental Sensor”)

Template code: A short unique identifier (e.g., “env_sensor_01”)

5. Add at least one Attribute:

Name: “Temperature” | Type: Decimal

Name: “Humidity” | Type: Decimal

6. Click Save.

Expected Result: Template appears in the Templates list and is available when creating Devices.

Step 2: Create a Device

Purpose: Register your physical Device in /IOTCONNECT™. This generates the certificates and configuration needed for the Device to authenticate with the cloud.

Steps:

1. Go to Devices → Greengrass Device.

2. Click the Devices tab at the bottom.

3. Click Create Device.

4. Fill in the fields:

Field Description Example
Unique ID A unique identifier (cannot be changed later) my-rpi-gateway-01
Display Name Human-readable name Factory Floor Pi
Entity Organizational unit Building-A
Template Template from Step 1 Environmental Sensor
Device Type Nucleus Classic or Nucleus Lite Nucleus Lite
Notes Optional description Located near CNC machine #3

5. Click Save (or Save & View).

Expected result: Device appears in the list with status Released (orange). This means the Device is registered but not yet connected.

Step 3: Download Connection Kit

Purpose: The connection kit contains certificates, private keys, and configuration that your device needs to authenticate securely with /IOTCONNECT™

No AWS IAM credentials are needed.

Steps:

1. In the Greengrass Device list, find your newly created Device.

2. Click the download icon (Actions column) to download the connection kit.

3. A zip file downloads (e.g., my-rpi-gateway-01-bundle.zip).

4. Transfer this file to your physical Device using SCP:

scp my-rpi-gateway-01-bundle.zip user@device-ip:~/

Expected result: You have the zip file on your target Device, ready for the installer.

What’s inside the bundle:

X.509 Device certificate (device.pem.crt)

Private key (private.pem.key)

Root CA certificate (AmazonRootCA1.pem)

Configuration file with MQTT endpoint and Device metadata

Step 4: Install Greengrass Nucleus

Run the appropriate installer on your target Device. SSH into the Device and execute:

Step 5: Verify Connection

Purpose: Confirm your device has successfully connected to /IOTCONNECT™.

Steps:

1. Return to the /IOTCONNECT™ portal → Devices → Greengrass Device.

2. Find your Device in the list.

3. Check the Device Status column.

Expected result: Status shows Connected (green) within 1-2 minutes of running the installer.

If the Device does NOT show as Connected:

Verify internet connectivity on the Device: ping 8.8.8.8

Check the service status: systemctl status greengrass-lite.target

Check logs: journalctl -u greengrass* -f

Ensure port 8883 (MQTT) is not blocked by a firewall.

Step 6: Deploy a Component

Purpose: Deploy application logic to your device. We’ll use a pre-built demo component that sends sample telemetry — no coding required.

Register the Component:

1. Go to Package tab (bottom) → Components section.

2. Click Create Component.

3. Upload the pre-built component: Download iotc-gg-component-basic-demo-1.0.0.zip from downloads.iotconnect.io/greengrass/components/

4. Upload the recipe file (included in the zip).

5. Click Save.

Create a Package:

1. Click Create Package.

2. Enter a package name (e.g., “Demo Package”).

3. Select your template.

4. Select the Basic Demo as a custom component.

5. The /IOTCONNECT™ Default Component is automatically included.

6. Click Save.

Deploy:

1. Go to the Deployments section.

2. Click Create Deployment.

3. Name your deployment.

4. Select the package you created.

5. Select target type and target device.

6. Click Deploy.

Expected result: Deployment status changes from Pending → Successful within 2-5 minutes. Telemetry data appears in the Live Data tab.

Step 7: View Live Telemetry

Purpose: Confirm data is flowing from your device to the cloud.

Steps:

1. Click on your device’s Unique ID in the device list.

2. Navigate to the Live Data tab.

3. Select Telemetry view.

Expected result: You see live sensor readings updating every few seconds (the Basic Demo sends random temperature / humidity values).

You can also:

Graph view: See telemetry plotted as real-time charts.

Tabular view: See raw data in table format with timestamps.

Latest Value: See the most recent reading for each attribute.

Historical Data: Query past telemetry by date range and export as CSV.

ⓘ CONGRATULATIONS

Your Greengrass Device is now connected and sending telemetry! Next steps:
• Build custom components — See the SDK Development section
• Deploy to production — See Best Practices
• Add more Devices — Repeat Steps 2-6 for each Device
• Set up alerts — Configure Rules in the template to trigger notifications on telemetry conditions