Configures either the GPIO inputs of the device or one of its IOX modules. Send configs for GPIO or ioxModule for IOX, not both.
Requires RegisterDevice first. GPIO: labels the inputs that InitiateDevicePeripheralSetup enabled in this install session. The labels replace the previous set, so send every input that should stay labelled; an input left out ends up unlabelled. Device types: Seatbelt, Digital, DoorSensor and PTO (not case sensitive). Analog is not supported. IOX: applies the settings to the module and replaces its whole configuration, so a setting left out is turned off. No InitiateDevicePeripheralSetup call is needed. The request is validated first, then the module must be detected on the device (vehicle ignition on, IOX cable connected; it appears in GetDeviceStatus as ioxDevices with configurable true), and only then is anything sent to the module. Applying a configuration reboots the module and can take a few minutes. A failed apply can leave the module different from what MyAdmin recorded, so apply a good configuration again, and retry once if the module did not verify. Use GetDeviceStatus with includeIoxModuleStatus to check the result. Errors (error code): InvalidInputNumber (empty list, a number outside 1 to 8, a duplicate, or an input not enabled by InitiateDevicePeripheralSetup), InvalidDeviceType, AmbiguousPeripheralRequest (both configs and ioxModule were sent), InvalidIoxModuleType, InvalidIoxConfiguration (the settings are not valid for that module), IoxModuleNotDetected, IoxConfigurationFailed (the settings could not be applied or did not verify after the module rebooted), DeviceNotRegistered, InvalidToken (invalid or expired install token), GenericDeviceError, UnsupportedApiVersion.
Parameters
apiKey
The API key (user ID) of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.
configs
The GPIO labels to apply, as DevicePeripheralConfig items. Required for a GPIO request; omit for an IOX request.
Requires RegisterDevice first. GPIO: labels the inputs that InitiateDevicePeripheralSetup enabled in this install session. The labels replace the previous set, so send every input that should stay labelled; an input left out ends up unlabelled. Device types: Seatbelt, Digital, DoorSensor and PTO (not case sensitive). Analog is not supported. IOX: applies the settings to the module and replaces its whole configuration, so a setting left out is turned off. No InitiateDevicePeripheralSetup call is needed. The request is validated first, then the module must be detected on the device (vehicle ignition on, IOX cable connected; it appears in GetDeviceStatus as ioxDevices with configurable true), and only then is anything sent to the module. Applying a configuration reboots the module and can take a few minutes. A failed apply can leave the module different from what MyAdmin recorded, so apply a good configuration again, and retry once if the module did not verify. Use GetDeviceStatus with includeIoxModuleStatus to check the result. Errors (error code): InvalidInputNumber (empty list, a number outside 1 to 8, a duplicate, or an input not enabled by InitiateDevicePeripheralSetup), InvalidDeviceType, AmbiguousPeripheralRequest (both configs and ioxModule were sent), InvalidIoxModuleType, InvalidIoxConfiguration (the settings are not valid for that module), IoxModuleNotDetected, IoxConfigurationFailed (the settings could not be applied or did not verify after the module rebooted), DeviceNotRegistered, InvalidToken (invalid or expired install token), GenericDeviceError, UnsupportedApiVersion.