Notecard Walkthrough
A guided tour of Notecard, from the JSON request-and-response protocol through the design techniques that keep a production deployment low-power and low-bandwidth. Read it start to finish, or jump to the section you need.
Overview
How Notecard and Notehub work together, and what to know before you issue your first request.
Notecard Requests & Responses
The JSON protocol Notecard uses, and the shape of the responses it returns.
JSON Fundamentals
A primer on the JSON data types and syntax used throughout the Notecard API.
Notecard Interfaces
Issue requests over USB, UART, or I2C, and understand the wiring and settings each interface expects.
Essential Requests
The handful of API requests that nearly every embedded IoT application built with Notecard needs.
Time & Location Requests
Obtain the time and location of a device, and use the onboard GPS module for location tracking.
Inbound Requests & Shared Data
Initiate requests from a cloud application and deliver them to Notecard through Notehub.
Web Transactions
Use web.get, web.put, web.post, and web.delete to reach third-party APIs and services.
Low-Power Firmware Design
Firmware and API techniques for minimizing power consumption in battery-operated applications.
Low Bandwidth Design
Preserve and monitor bandwidth in applications expected to operate over long periods of time.
Working with the Notecard AUX Pins
The modes available for the AUX pins, and how to put them to work in your project.
Updating Notecard Firmware
Update Notecard firmware using Notehub, the In-Browser Terminal, STM32CubeProgrammer, or the Notecard CLI.
Advanced Notecard Configuration
Query device state, customize behavior, and set other advanced Notecard configuration.
