Getting Started with CYW20819
This guide teaches you how to get started using Atmosphere with CYW20819 development kits. This includes creating your first project, programming the project’s firmware into your kit, registering the device to Atmosphere, and having its data displayed on a dashboard.
This guide demonstrates a simple project that reads the hardware’s temperature sensor once per second, which displays that information on the Atmosphere IoT app using a label, and sends the data to the cloud.
Prerequisite: You should already have an Atmosphere account.
- CYW920819EVB-02 Evaluation Kit
- Tablet or smartphone mobile device
- Atmosphere IoT app. The mobile app allows you to view your registered devices and display and run the project’s interface. You can download the Atmosphere IoT app from its downloads page or through the Apple App Store or Google Play Store.
- Atmosphere IoT Agent. The Atmosphere IoT Agent is a local application that runs in the system tray and acts as an intermediary between the computer’s connectivity protocol drivers and the browser running Atmosphere, used to assist in programming your device. You can download the Atmosphere IoT agent from its downloads page.
- Ensure Bluetooth is enabled on the mobile device you’ll use to interact with the kit.
Users working with the CYW920819EVB-02 on macOS need to download the Cypress ModusToolbox SDK in order to program. This doesn't need to be run or used, but downloads the necessary drivers needed to program the CYW920819EVB-02 on macOS.
Step 1 of 9: Create a New Project
Navigate to Atmosphere Studio from the side menu. When you visit Studio for the first time in a session, you are brought to the Studio Projects screen.
- Click the button. This displays a New Project window.
- Select the CYW920819EVB-02 project type and give the project a name, then click Create. This opens a new project in Studio.
This guide walks through the step-by-step process to perform actions in Studio, but doesn't cover the in-depth aspects of Studio itself. To learn more about using Studio, its areas and features, and Studio elements, visit the Atmosphere Studio section.
Step 2 of 9: Create the Project’s Embedded Firmware
The first aspect of building this sample project is adding elements to the Embedded tab to create the project’s embedded firmware. This involves .
- Add the following elements to the canvas by clicking them in the Element Toolbox:
- Interval element: The interval element sets the project to run at the time set in the element’s properties, which by default is set to once per second (1000 ms).
- NCU15WF104F60RC element: The NCU15WF104F60RC element reads temperature data. This is a temperature sensor that is onboard the CYW920819EVB-02, and its element is imported in the Element Toolbox for its projects by default.
Both of these elements will work as intended by default, so none of their properties need to be changed.
- Connect the interval element to the NCU15WF104F60RC element. This creates an event between them, which can be seen in either the interval element’s properties, or by clicking the connector’s button. The event added is within the
Intervaltrigger, with the NCU15WF104F60RC ability
Read Temperature. This means that when the interval element is triggered (which is every second), it will read the temperature value from the sensor.
- Add a BLE characteristic element to the canvas, which creates a GATT characteristic to use in your project. This element is a coupled element that bridges the project between the Embedded tab and Application tab, meaning it’s included on both tabs. Select the BLE characteristic element, and change the Read Data Type, Write Data Type, and Notify Data Type fields to
Floating Point (32-bit). This allows the element to read and write a floating point value, which is the temperature value that will be sent to it.
- Connect the NCU15WF104F60RC element to the BLE characteristic element, which ties the value of the temperature sensor to the Application tab. This creates an event between the two elements of
Set Valueunder the NCU15WF104F60RC’s
Temperature Readtrigger, which sets a value for the project’s interface after it reads the temperature sensor’s value.
That’s all for work in the Embedded tab. To this point, an interval has been set that will run once per second after the project opens, and when run will read the onboard temperature sensor. The Embedded tab canvas should resemble the following image:
Step 3 of 9: Create the Project’s Interface
The second aspect of building this sample project is adding elements to the Application tab to create the project’s visual component.
Click the Application tab to move to the application area of the project. Notice how the Element Toolbox has changed, and that the coupled BLE characteristic element is displayed on the canvas.
- Click the button in the Application tab’s toolbar to display the app builder. This area creates the visual interface for your project. By default this uses the smallest display size supported for an interface (320x560), but you can add an interface size by clicking the button. Use the display size that fits best with your mobile device.
- Add an interval element to the canvas, and connect it to the existing BLE characteristic element. This creates the trigger event
Read, which reads the value of the BLE characteristic element sent from the Embedded tab every time the interval triggers.
- Add a label element to the canvas. The label element displays text on a project’s interface. Notice when the label is added to the canvas, a corresponding interface component is added to the app builder. The label component can be moved around on the interface wherever you like.
- Connect the BLE characteristic element to the label element. This creates an event between the two elements of
Set Textunder the
Readtrigger, which sets the text to the value of the label when the BLE characteristic is read. This correlates the set value from the BLE characteristic element in the Embedded tab to the label on the interface. Within the Set Text event, modify the Text field to
"Temperature: " + readData.toFixed(2) + "°C". This argument reads the temperature data and truncates the value to two decimal places, and also appends the Celsius unit to the end of the value.
This is all that needs to be done for the project’s interface, simply using a label to a text value. To this point, an interval has been set that will read the BLE characteristic value once per second, which will display the read the temperature value on the interface label. The Application tab’s canvas should resemble the following image:
Step 4 of 9: Enable the Project’s Cloud Connectivity
The third aspect of building this sample project is enabling it for cloud connectivity. This is done on both the Application and Cloud tabs.
- While still in the Application tab, add a cloud event element to the canvas. The cloud event element is a coupled element between the Application and Cloud tabs that enables a project’s data to be sent to Atmosphere.
- Connect the BLE characteristic element to the cloud event element. This adds the
Send Eventevent to the
Readtrigger, which sends the set value data to Atmosphere when the BLE characteristic is read.
- Click the Cloud tab to move to the cloud area of the project. Notice how the Element Toolbox has changed, and that the coupled cloud event element is displayed on the canvas.
- Add a cloud storage element to the canvas, and connect the cloud storage element to the cloud event element. This allows Atmosphere to store data sent to it from the connected cloud event element.
That’s all for creating the project! With the added cloud connectivity, the project will send the temperature value from the Embedded tab to the Application tab, which then uses a cloud event to send it to the Cloud tab, where it’s connected to a cloud storage element to store the data on Atmosphere.
The final canvas for each tab should resemble the following images:
Step 5 of 9: Compile the Project
Once the project is finished, it needs to be compiled. Compiling readies the entire project’s source code for deployment.
- From any tab, click the button in the project options menu on the top-right of the screen. You’ll see a loading graphic on the screen, and will receive a notification when the project is compiled.
Step 6 of 9: Program Firmware into the Device
With the project compiled, your CYW920819EVB-02 can be programmed with the project’s embedded firmware.
Prior to programming a device, ensure you have the following configuration:
- The device is connected to the computer via USB.
- The Atmosphere IoT Agent is installed on the computer and running.
- An Internet connection is maintained.
- The CYW920819EVB-02 is in recovery mode. To put the CYW920819EVB-02 into recovery mode: press and hold the reset button, then press and hold the recover button. Release the reset button, wait one second, then release the recover button.
There is no visual indication of the board going into recovery mode, but the board is ready for programming. With setup complete, you can program your board:
- While the Embedded tab is active, click the button from the tab’s toolbar. This displays the Program Firmware window.
- Under Device Port, select the communication port the device is connected to.
- Click Program to start programming. When complete, you’ll receive a notification stating the device is programmed with the project’s embedded firmware.
Once the device is programmed, the CYW920819EVB-02 reboots and is programmed with the project’s embedded firmware.
Step 7 of 9: Register the Device
With firmware installed, the device can now be recognized and connected to Atmosphere. From here, open the Atmosphere IoT app on your mobile device. We’ll use the mobile app to both register the device, and eventually view the label data on the project’s interface.
To register a device:
- Navigate to the Devices page, and click the button in the top-right to display the Register Devices window. When the window opens it will automatically begin scanning for available devices within range.
- Ensure your CYW920819EVB-02 is within range from the device you are attempting to register from, otherwise it may not appear.
- The list of available devices appears. Select your device you just programmed and click Register.
The device is registered to Atmosphere and displayed on your Devices page.
Step 8 of 9: View the Project Interface
Each registered device has its own dedicated dashboard, which displays its information and is where you access the device’s interface to interact with it. Select your newly-registered device on the Devices page to access its dashboard.
The interface created in Studio’s Application tab is available on a device’s dashboard to interact with it. As long as the device is powered on and connected to Atmosphere, it can be interacted with.
To display the interface you created, click the button at the top of the screen. This opens the project interface from within the Atmosphere IoT app.
The project’s interface shows the temperature value on the label.
Step 9 of 9: View Device Data
Now that the device’s data is sent to Atmosphere, let’s view it through one of the many device dashboard widgets available. In this guide we’ll use a data glance to display temperature readings. We’ll do this directly on the device’s dashboard page itself, so click on the newly-added CYW920819EVB-02 to enter its page.
- To add a widget to the device’s dashboard, click the button on the side of the page. This displays the menu of available widgets. Select the data glance widget to add a data glance to the dashboard.
- Once on the dashboard, click the widget’s menu icon to display its menu, then click Settings.
- In the data glance’s settings, modify the following properties:
- Name: Give the widget a name, such as “CYW Temperature”
- Units: Enter
°Cfor its unit of measurement.
- Icon: Select an icon that represents the data, such as the
- Color: Give the widget a color that represents the data.
- In the Device Parameters field, click Select to enter the progression of selecting the following parameters for the data glance’s device information:
- Select Cloud Storage: Click the cloud storage that is storing the temperature data.
- Select Value: Select the temperature dataset.
- When finished click Save. The data glance is then populated with the temperature reading.
Congratulations, you just finished a complete CYW20819 project with Atmosphere!