Mcity API

This is an implementation of the OCTANE API for Mcity. OCTANE is developed and supported by Mcity at The University of Michigan.

This API enables enumeration and control of infrastructure at the Mcity to facilitate repeatable testing of highly automated vehicles and other systems.

Skyline

Skyline, the visual application that runs on OCTANE, is available at skyline.um.city.

Access

To access this API you will need an access token/key provided by Mcity staff.

Support

During reservation: mcity-test-fac@umich.edu
Before reservation: Please contact mcity-engineering@umich.edu.

Examples

Example code utilizing the API both through REST and Socket.IO interfaces can be found at Mcity's public Github repository, Mcity-octane-examples.

Documentation

If you'd like to contribute or suggest features for OCTANE, please use the issue tracker in Mcity's Github repository

Documentation of the REST and websocket protocols are available here.

Testing

Utilizing your API key you can connect and test web services using the interface located here.
The Swagger interface allows for usage of the API from a web browser. Click the Authorize button at the top right of the page to enter your API key.

WebSocket Test interface

The API also provides Socket.IO support for listening to a subscribable streams of events through web sockets. On connection you are defaulted to the user and facility information channel.

Documentation of channels and events can be found here.

OCTANE provides a very basic web interface for testing an instances SOCKET.IO functionality here.

Data Recording

Click for debug tool