API Reference nerves_gate_sdk v#0.1.0

Copy Markdown

Modules

Implemented by device firmware and the host simulator.

CAN frames and process-owned receive subscriptions. No interface configuration.

A classic CAN frame. Data is at most eight bytes; FD frames are not supported.

CAN availability. Configuration remains platform-owned.

Read-only observations of attached equipment.

Public equipment identity and reachability.

Process-owned subscriptions to public observations. Subscribe before querying.

A public event delivered directly to the subscribing process.

Read-only network observations. Network configuration belongs to the platform.

A public network observation, without platform configuration.

Exclusive, process-owned RS485 sessions. Claims are released on owner exit. Receive data arrives as Events.Event with topic {:rs485, port} and binary value. The platform owns serial settings; applications cannot open Linux devices.

A logical RS485 port and its availability.

SD storage observations and application-owned data directories.

Availability of application storage. Platform state does not require an SD card.

Read-only device identity and runtime information.

Public device identity. No credentials or distribution settings.

Mix Tasks

Compiles in production mode and writes <app>-<version>.ez in the current directory, or to --output path. Set :nerves_gate_sdk_requirement in the application's OTP :env.