Skip to content

Station API

KNOT station API allows to control the KNOT docking station.

Info

The current version is v1, the API is frozen. Any future update will be backward compatible.

Current features

  • Ping the station.
  • Reboot the station.
  • Unlock a specified spot.
  • Confirm the return of a scooter.
  • Force the station to read again the identifier of all scooters.
  • Heartbeat (every 30 minutes or when you send a ping, the station sends the voltage of all scooters locked on the station, the voltage and the temperature of the station).
  • Send feedback to the badge reader.
  • Configure the volume of the speaker.
  • Be notified when:
    • a spot is unlocked.
    • a spot is locked.
    • the station started.
    • there is a power outage.
    • a spot isn't working / has a default.
    • the station is shaken (potential vandalism attack).
    • a badge is put on the station RFID reader (RFID ISO 14443A).
    • the connection state of the station change: (connected, disconnected).

Planned features

  • Configure LED color of spot unlocking.
  • Configure LED color of scooter return confirmation.
  • Configure sound of spot unlocking.
  • Configure sound of scooter return confirmation.
  • NFC unlocking.

Note

If you are interested in any of these features, please let us know so we can prioritize them according to requests.

Included service handled by KNOT

  • OTA upgrade