0. 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.

What are vendOS apps?

vendOS apps are built to be displayed and interacted with on vending machine screens. They are made from frontend web technologies and get stored locally on the hardware. The apps have the ability to fully interact with the vending hardware via websockets or through our simple vendOS JS library. 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 fleet of machines. 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.

Platform Overfiew

vendOS apps are deployed to machines and interact with FieldCommand in order to create user experiences around smart vending.

Libraries & Tools

Developers interested in creating vendOS apps will need to be familiar with a couple of tools in the vendOS platform. These are:

  • vendOS JS: An open-source, promise-based library to help applications communicate easily with vendOS FieldCommand. NPM | Minified
  • vendOS Devtools: A Chrome Extension to help application developers mimick a vending machine running FieldCommand. Chrome Web Store

This documentation covers the use of these tools and also some of the general concepts around the vendOS development process.

We are currently BETA testing the librarys, documentation, chrome extension 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!