Skip to main content

Utilities overview

Lookup material for the SDK: the shape of the configuration object, the types and constants it exports, the errors it throws, and the helper functions that come with it. These are pages you come back to with a specific question, not pages you read front to back; the task guides are in the sections above.

Which page answers which question​

Your questionRead
What goes in configure()?Configuration
What type is this argument?Types
What value do I pass here?Constants and enums
What does this error mean?Errors
Is there a helper for this?Helpers

How the exported surface is organised​

Everything the package exposes comes from one barrel, so a single import path covers classes, types, constants and helpers:

import { ESPRMNeoBase, ESPTransportMode, ESPConfigError } from "@espressif/rainmaker-neo-base-sdk";
import type { ESPRMNeoBaseConfig, NodeConfig } from "@espressif/rainmaker-neo-base-sdk";

The SDK models the wire format and its own runtime shapes separately. Types ending in API are raw backend payloads in snake_case; everything else is the camelCase shape your app works with. You rarely need an API type.

Not everything exported is supported API

The barrel re-exports whole modules, which pulls in internal machinery. REST path builders, storage keys, and around a dozen message catalogues; alongside the documented surface. Treat anything not covered by these pages as internal: it can change without notice. A few option types are also missing from the barrel; Types lists which.