Vehicle

The Vehicle API provides access to vehicle profile and status.

Try it online

getCurrentVehicleProfilegetCurrentVehicleStatusLoad both

Use the buttons above to load data

Vehicle API demo

Load the current vehicle profile and real-time status; values are shown as key–value pairs (mock data)

Vue

<script setup>
import { ref, onMounted } from 'vue'
import woo from 'mini-sdk'

const profile = ref(null)
const status = ref(null)

onMounted(async () => {
  profile.value = await woo.getCurrentVehicleProfile()
  status.value = await woo.getCurrentVehicleStatus()
})
</script>

<template>
  <div v-if="profile">
    <p>{{ profile.brand }} {{ profile.model }} ({{ profile.year }})</p>
    <p>VIN: {{ profile.vin }}</p>
  </div>
  <div v-if="status">
    <p>电量: {{ status.batteryLevel }}% | 里程: {{ status.odometer }}km</p>
  </div>
</template>

React

import { useState, useEffect } from 'react'
import woo from 'mini-sdk'

function VehicleInfo() {
  const [profile, setProfile] = useState(null)
  const [status, setStatus] = useState(null)

  useEffect(() => {
    woo.getCurrentVehicleProfile().then(setProfile)
    woo.getCurrentVehicleStatus().then(setStatus)
  }, [])

  return (
    <>
      {profile && (
        <div>
          <p>{profile.brand} {profile.model} ({profile.year})</p>
          <p>VIN: {profile.vin}</p>
        </div>
      )}
      {status && (
        <p>电量: {status.batteryLevel}% | 里程: {status.odometer}km</p>
      )}
    </>
  )
}

Import

import woo from 'mini-sdk'
// 或
import { vehicle } from 'mini-sdk'

API reference

getCurrentVehicleProfile

Get profile information for the currently bound vehicle.

const profile = await woo.getCurrentVehicleProfile()

Return value VehicleProfile:

Field	Type	Description
vin	string	Vehicle identification number (VIN)
brand	string	Brand
model	string	Model
year	number	Model year
color	string	Color
licensePlate	string	License plate number

const profile = await woo.getCurrentVehicleProfile()
console.log(`${profile.brand} ${profile.model} (${profile.year})`)

---

getCurrentVehicleStatus

Get real-time status for the current vehicle.

const status = await woo.getCurrentVehicleStatus()

Return value VehicleStatus:

Field	Type	Description
mileage	number	Total mileage (km)
fuelLevel	number	Fuel level (percent)
batteryLevel	number	Battery state of charge (percent)
isLocked	boolean	Whether the vehicle is locked
location	{ lat: number, lng: number }	Vehicle position

const status = await woo.getCurrentVehicleStatus()

if (status.fuelLevel < 20) {
  woo.showToast({ title: '油量不足，请及时加油', icon: 'none' })
}

Quick reference

Method	Description	Signature
getVehicleInfo	Get basic vehicle information	() → Promise<VehicleInfo>
getVehicleStatus	Get real-time vehicle status	() → Promise<VehicleStatus>
onVehicleStatusChange	Listen for vehicle status changes	(callback) → void