EV/EVSE onboarding steps
Steps to onboard an Electric Vehicle (EV) or Electric Vehicle Supply Equipment (EVSE)
📣 Note: Throughout these documents, we reference EVSEs and Charge Points. With respect to our device onboarding process, these terms are interchangable.
📣 Note: The step order is dynamic, so when fetching the current step the query must be ready to accept any step type.
Select vehicle make
When is this step returned?
This step is returned if the user needs to select their electric vehicle make (company/brand). The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected vehicle make.
Try out completing this step
Select vehicle variant
When is this step returned?
This step is returned if the user needs to select their electric vehicle model/variant. The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected model/variant.
📣 Note: If you would like to go back to the previous step (in this case, the vehicle make step) and select a different make, you should call the selectVehicleMakeForSmartFlexOnboarding mutation with the id of the make you want to select (eg., "selectedOption":"Tesla" ). This will reset the current step to the vehicle make step and allow the user to select a different make. You will now get a new instance of the SelectVehicleVariantstep with the variants filtered to only those that match the selected make.
Try out completing this step
Select charge point make
When is this step returned?
This step is returned if the user needs to select their charge point make. The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected make.
Try out completing this step
Select charge point variant
When is this step returned?
This step is returned if the user needs to select their charge point model/variant. The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected model/variant.
Try out completing this step
Select electric vehicle or charge point
When is this step returned?
This step is returned if the user needs to select between onboarding their electric vehicle or their charge point.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected integration (ELECTRIC_VEHICLE or CHARGE_POINT).
Try out completing this step
Setup virtual key
When is this step returned?
This step is returned if the user needs to setup a virtual key for their device. The provided URI navigates the user to where they can set up the virtual key.
Try out fetching this step
What is needed to complete this step?
There is no input we need beyond the typical wizardId and stepId to complete this step. This step functions as a prompt to direct users to setup their virtual key because their journey will error later on if they do not.
📣 Note: The step is currently only needed for Teslas that require it.
Try out completing this step
Select user vehicle
When is this step returned?
This step is returned if the user has multiple devices connected to their OEM's account and they need to select a single device to onboard. The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected device.
Try out completing this step
User action required
When is this step returned?
This step is returned if device cannot be onboarded without some action from the user. An example of this is if the user needs to update their device's software.
Try out fetching this step
What is needed to complete this step?
There is no input we need beyond the typical wizardId and stepId to complete this step. This step functions as a prompt to direct users to complete an action because their journey will error later on if they do not.
Try out completing this step
Demo​
Here is a demo of how we can put these together to create a dynamic wizard which will load the appropriate options from the result of the previous step. This shows the UI up to the point where you would be redirected to the OAuth process of the vehicle manufacturer. The mocks are hard-coded for values for a Tesla vehicle and charger. Choosing the third option for the charger model shows a loader to indicate a redirect to OAuth would be performed.