Vehicle Signal Decoding Endpoints
Base URLs
https://vehicle-signal-decoding.dimo.zone
List All Device Config URLs
Get Device Config URLs by VIN
GET
{baseUrl}
/v1/device-config/vin/{vin}/urls
Retrieves all available device configuration URLs by Vehicle Identification Number.
Path Parameters
Name | Type | Description |
---|---|---|
vin* | String | Vehicle Identification Number (VIN). |
Query Parameters
Name | Type | Description |
---|---|---|
protocol | String | CAN Protocol, this can be either |
Get Device Config URLs by Ethereum Address
GET
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/urls
Retrieves all available device configuration URLs by Ethereum Address.
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
Query Parameters
Name | Type | Description |
---|---|---|
protocol | String | CAN Protocol, this can be either |
Retrieve Device Configs
Developer Notes
The following endpoints are essentially returning the JSON blob or text of each configuration. To get the {templateName}
of each device config, please fetch the URLs first from Get Device Config URLs by VIN.
Get PID Config JSON
GET
{baseUrl}
/v1/device-config/pids/{templateName}
Retrieve the PID configurations for a given template name.
Path Parameters
Name | Type | Description |
---|---|---|
templateName* | String | Template name of the PID config. |
Get Device Setting JSON
GET
{baseUrl}
/v1/device-config/settings/{templateName}
Retrieve the device setting configurations for a given template name.
Path Parameters
Name | Type | Description |
---|---|---|
templateName* | String | Template name of the device setting config. |
Get DBC Text
GET
{baseUrl}/v1/device-config/dbc/{templateName}
Retrieve the DBC file for a given template name.
Path Parameters
Name | Type | Description |
---|---|---|
templateName* | String | Template name of the DBC config. |
Device Operations
Get Device Status by Ethereum Address
GET
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/status
Retrieves the current status of the device identified by Ethereum Address.
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
Set Device Status by Ethereum Address
PATCH
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/status
Sets the current status of the device identified by Ethereum Address.
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Request Body
Name | Type | Description |
---|---|---|
config* | Object |
Get Device Jobs by Ethereum Address
GET
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/jobs
Retrieves the jobs of the device identified by Ethereum Address.
⚠️ Currently not working as this is under construction
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
Get Pending Device Jobs by Ethereum Address
GET
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/jobs/pending
Retrieves the pending jobs of the device identified by Ethereum Address.
⚠️ Currently not working as this is under construction
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
Set Device Job Status by Ethereum Address
PATCH
{baseUrl}
/v1/device-config/eth-addr/{eth-addr}/jobs/{jobId}/{status}
⚠️ Currently not working as this is under construction
Path Parameters
Name | Type | Description |
---|---|---|
eth-addr* | String |
|
jobId* | String | |
status* | String |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer authentication using the |
Swagger Doc
Last updated