- Overview
- Install and authenticate
- Configure a connection
Configure a connection
Create a named connection profile after installing the SDK. The profile gives the command-line tools and examples one reusable set of ECN connection settings without storing secret values.
Create a named profile
Section titled “Create a named profile”For interactive work, run:
picogrid-ecn configurepicogrid-ecn doctor --profile NAMEA profile selects the endpoint, integration identity, credentialed authentication
method, credential-file references, publication wire format, and optional reconnect
policy. It persists only non-secret settings and credential-file references in the
platform/XDG configuration location with restrictive directory and file permissions.
It never writes a bearer token, edits shell startup files, or stores secret values in
command history.
Reviewed-container-network mode is deliberately available only through environment
variables or direct ECNConfig construction, so its security attestation is never
silently persisted to a profile file.
Provide:
- a DNS name or IP literal (IPv4 or IPv6) without a scheme or port;
- a port from 1 through 65535; use 8883 for mTLS or 8884 for bearer or local
legion-system-authauthentication, unless the endpoint owner provided a different port; - an integration name of 2 through 128 ASCII letters, digits, underscores, or
hyphens, starting and ending with a letter or digit (
geolocationandresponseare reserved case-insensitively); and - exactly one credentialed authentication method.
Verified TLS is the default. Plaintext or unverified TLS still requires the explicit
allow_insecure=True opt-in for a loopback mock. The separate
ReviewedContainerNetwork opt-in permits plaintext only with NoAuth; each is
rejected without the other, and credential or mTLS material cannot be combined with
it.
Use the profile
Section titled “Use the profile”Examples accept --profile NAME or ECN_PROFILE. Environment variables remain
supported for CI and automation: ECN_HOST,
ECN_MQTT_PORT, ECN_INTEGRATION_NAME, and the authentication variables described
on the authentication page. ECN_AUTH explicitly selects
mtls, bearer, legion, or none; in environment-only use it selects the
authentication path, and with a profile it must remain coherent with that profile’s
credential references. ECN_AUTH=none additionally requires
ECN_PLAINTEXT_CONTAINER_NETWORK and defaults to port 1883.
ECN_WIRE_FORMAT selects json or protobuf for entity and location publication.
Optional configure flags and the six per-field reconnect-policy environment
overrides are listed with their precedence in the
configuration reference.
Application code may still construct one immutable ECNConfig directly. Use the
detailed configuration reference for fields and
limits.
Version 0.2.0 · branch main
