ESP RainMaker Neo SDK
@espressif/rainmaker-neo-base-sdk is the TypeScript SDK for ESP RainMaker Neo Cloud. It covers everything an IoT cloud SDK needs:
- Authentication
- Device provisioning
- Groups and nodes
- Device control
- Live updates over MQTT
- Schedules
- Triggers
- Automations
- Sharing
note
MQTT is the primary path for device and SDK communication. The SDK and each device share a direct MQTT pipeline, so updates and control stay fast and seamless without extra request hops.
A reference application is available so you can evaluate and try out features faster before you build your own client.
Getting started in three steps
- Get your deployment details from the published client configuration (
rmng-client-outputs.json). - Configure once with
ESPRMNeoBase.configure()— pass those values (and any adaptors your app needs). - Start using the SDK — sign in, then call the APIs for groups, nodes, devices, and the rest.
See Getting started for the install and configure walkthrough.
Hierarchy tree
This is the hierarchy tree the SDK provides. Configure once, sign in, and everything else hangs off that path:
Where to go next
- Getting started — install, configure, first sign-in
- Adaptors — wire up native features
- Authentication — sign a user in
- Provisioning — add a device
- Device control — control a device
- Groups — organise nodes
- Building custom apps — what a client needs from a deployment
- Terminology — the data model the SDK exposes
- Getting started with the API — the auth chain the SDK performs for you
- Configuration reference — every field of
ESPRMNeoBaseConfig