Open Liberty Space Rover Mission is an interactive IoT game designed to showcase microservices with modern Java technologies in a fun way. The mission is to guide the Space Rover using hand gestures to its home while visiting planets along the way to gather supplies. Make sure to avoid any obstacles (asteroids, black-hole, etc.) in your path. 🚨 Beware of extra damage on the Sun! 🚨
These five hand gestures are used to move the Space Rover across the game board. 
The gesture detection is built upon using popular open sourced computer vision libraries such as OpenCV, CVZone and Mediapipe. Computer Vision works by gaining high-level understanding from digital images/videos to understand and automate tasks that the human visual system can do. OpenCV was built to provide a common infrastructure for Computer Vision applications and to accelerate the use of machine perception.
- Space Rover hardware component with the project code compiled and running.
- Game Board hardware component with the project code compiled and running.
- Gesture Control System client with webcam facing a defined area for users to control the Space Rover.
- Docker CE or Docker Desktop either running on the Gesture Control System's hardware or on its own hardware.
For setup, cleanup, and troubleshooting instructions, see documentation.
Open Liberty Space Rover Mission is playable in four different game modes: Classic, Planet Hop, Guided, and Sudden Death.
- Classic: Pick up all four planet resources (in any desired order) as fast as possible while avoiding obstacles.
- Planet Hop: One planet will randomly turn on at a time -- go to the planet that is lit up to retrieve its resource. The availability of the planet's resource runs on a timer -- you can only retrieve the resource when its light is on! The planet's light will start blinking if you are running low on time to retrieve its resource, and the next planet's light will automatically turn on when the time is up. Pick up as many planet resources as possible within the time limit while avoiding obstacles.
- Guided: One planet will turn on at a time in a specific order. Pick up all four planet resources in the order that the planet lights turn on as fast as possible, while avoiding obstacles.
- Sudden Death: A variant of Classic mode, but if you hit an obstacle, you immediately fail the mission.
The Client is built using React and served using Nginx. The UI is used to enter the player's name, start the game, view current game stats, and view the leaderboard. It interacts with the Game Service using websockets and the Leaderboard Service using HTTP.
The Leaderboard Service is built using Open Liberty. It is used to provide a REST API for the Client to query for past game information and for the Game Service to add the information after a game completes.
The Game Service is built using Open Liberty. It holds the current game state and is the piece that connects all the different components together. It gets information from the hardware devices using websockets and sends events to the Client to update the health and score. It also updates the Leaderboard Service about the game information at the end of a game.
MongoDB is used to store information about past games. It interacts with the Leaderboard Service.
The Prometheus server scrapes metrics from the Game Service and sends them to Grafana.
Grafana takes the metrics scraped by the Prometheus Server and displays them on a dashboard.
The Webcam and WiFi Enabled Standalone Device is used to run the hand gesture game controls which is powered by CV Zone which uses Open CV under the hood.
The Space Rover is the physical device built using an Arduino which roams the game map. This component picks up RFID cards/NFC stickers to determine if it has landed on a planet or hit an obstacle to the Game Service.
The Game Map is the physical game board which the Space Rover roams on. It emits LED's of different colour to signify planets and obstacles.
- RESTful Web Services (JAX-RS) 3.0
- Used for REST endpoints to interface with the leaderboard service.
- HTTP GET endpoint used to retrieve stats from MongoDB container.
- HTTP POST to update MongoDB with new statistics.
- Context Dependency Injection (CDI) 3.0
- Used to inject a MongoDatabase object and MongoClient used to interact with the MongoDB leaderboard database.
- MP Health 4.0
- Used to add a /health endpoint that determines if MongoDB is up and running.
- MP Config 3.0
- Used to store connection information to MongoDB such as the username, port, and encrypted password.
- MP FaultTolerance 4.0
- Used to retry connection attempts to MongoDB if they are not successful.
- MP OpenAPI 3.0
- Used for providing REST API documentation and UI for demonstration.
- WebSocket 2.0
- Used extensively to handle socket connections from the GUI, Gesture Control Service, Game Board, and Space Rover.
- MP Health 4.0
- Used to add a /health endpoint which returns the server status based on its ability to handle messages within a timeout.
- MP Config 3.0
- Used to configure known IP addresses and ports for external connections to the Space Rover, Game Board and Leaderboard.
- MP Metrics 3.0
- Used to record JVM metrics on the game service as well as a SimpleTimer that tracks the amount of time it takes for the GameService to respond to the health check test. This tells us a local round trip latency value determining how long it takes a message to be sent to the server and have the server respond.
- MP Rest Client 3.0
- Generates an HTTP client to send game end statistics to the leaderboard's REST server.
- MP OpenAPI 3.0
- Used for providing REST API documentation and UI for demonstration.
