Skip to main content
Version: 1.0

XMOD1

XMOD1 can host a total of 8 inputs and on/off outputs and supports DS18B20 and DHT22 sensors on a dedicated IO pin.

Device Configuration

To configure the number of inputs and outputs, generate a product configuration token from the Shelly X developer portal. The portal also allows for selecting the type of system led indication (addressable RGB or plain) and other helpful default config overrides.

XMOD.ApplyProductJWS

This method is used to apply a product configuration JWS token obtained from the developer portal.

Parameters:

PropertyTypeDescription

jws

string

Product configuration JWS

Response:

On success, an empty (null) response is returned. The module performs a factory reset and reboots into its new product form.

On error the token is not applied. Possible error codes are:

  • -107 Permission denied: if the module already has a JWS with the final flag set
  • -103 Invalid argument: if jws is missing, malformed or otherwise Invalid

XMOD.GetProductJWS

Obtain the currently-applied jws. This method takes no parameters and returns an object with a single jws key or error code -114 Unavailable if the device was never provisioned with a JWS.

XMOD.GetInfo

This method returns the parsed jws token as json. Notable properties are:

PropertyTypeDescription

p

string

Product, used as part of AP SSID, hostname, MQTT Client Id and other system identifiers

n

string

Product Name

url

string

Product URL

f

bitfield

FlagDescription
0x01Final. If set, no new JWS can be applied.

xmod1

object

XMOD1-specific settings

PropertyTypeDescription

ni

number

Number of Inputs

no

number

Number of Outputs (Switches)

led

number

Type of system led. 1: Plain, active-low; 2: WS2812 or compatible RGB