Docs BETA
/

Welcome

Start here to learn about vendOS


Hi there! 👋 We're excited you're here to learn about vendOS.

vendOS is a platform for building interactive user interfaces for deployment on smart vending machines. This documentation currently only explores the FieldCommand API, in future it will also include the other elements.

What can vendOS apps do?

vendOS apps are built to be displayed and interacted with on the machines screen. They are made from frontend web technologies and get stored locally on the machines PC to fully interact with the vending hardware via a WebSocket connection. This allows you complete freedom to design and develop whatever suits your needs and the needs of your clients.

What is vendOS made up of?

vendOS is an end to end platform consisting of two core components, Mothership and FieldCommand. Mothership is an online platform for managing, monitoring and uploading new apps to your machine fleet. FieldCommand is whats running on your vending hardware, it displays your apps and gives technicians an easy to use UI for configuring and maintaining the machine.

What do I have access to?

Currently we are only offering the ability to create local apps with our FieldCommand API. By late 2019 we will also open up the Mothership API that will allow you to send vend commands to machines from anywhere in the world.

API's and tools

  • FieldCommand API - The code that lives on the machine, it controls the hardware functions through WebSockets.

  • Mothership API - An API to remotely control vending functions. COMING SOON

  • vendOS CLI - A command line tool to deploy and locally test FieldCommand apps. COMING SOON

Conveniently, we have a tutorial that introduces you to the FieldCommand API. Ready to dive in?

We are currently BETA testing the API's, documentation and general platform so please do get in touch with us at [email protected] if you would like any changes, extra features or if something just does not make sense!