Skip to content

Installation and Developer Guide

Jump to bottom
Astrid Berntsson edited this page May 30, 2021 · 23 revisions

Welcome to the Smart Pet Buddy Guide. Here you will find all information on how to install and develop the application.

Technical Information

  • Smart Pet Buddy is a mobile application developed using Flutter.
  • Information is stored in Google Firebase.
  • The communication between the car and the app is handled through MQTT.
  • The emulator the car is running on is the SMCE.
  • Wiredash is used to collect feedback from the user.

Pre-Installation

Before you get started, consider having the following installed on your computer can make the setup process smoother

Installation

To get started, please make sure you have the following software installed on your computer:

Installing Flutter

Flutter is currently supported by Windows, macOS, and Linux. Visit the links below to get a full in-depth guide to installing Flutter for your operating system.

As of the last commit made to this project, there are no known bugs, however if the user has trouble getting Flutter to run, debugging tools such as Flutter Inspector may help resolve the issue.

Installing the IDE

Download and install the IDE you prefer:

Getting started

  • Clone our repository
  • In Android Studio, open the project by selecting [FILE], then [Open..]
  • Find the cloned repository folder in your computer, double click and make sure to select “smart_pet_buddy” folder (this way Android Studio will recognize that it’s a flutter project)
  • Go to the “pubspec.yaml” file in the side menu or see if the “flutter pub get” command appears somewhere. Make sure to click it and let it run and make sure all dependencies are set up correctly.
  • Make sure you have your Mqtt broker running before you run our application or the arduino sketch.
  • Open Android Studio simulator and run the application
  • After you sign up/log in with your own account, you will be able to enter your own MQTT broker's address. After connecting our smart pet buddy application to the broker, you can controller the smart car in SMCE emulator either with manual mode, race mode and pre-defined moving pattern.
  • Open SMCE emulator and click on [+] to select our smartcar.ino sketch and click [COMPILE].
  • When you start the sketch, you should be able to steer the car using the controls in the “smart_pet_buddy”. If you’re using race mode, the car will respond to the movements you make by tilting your mobile device.

Emulators

Apps made using Flutter work on both iOS and Android devices. In order to see the app in realtime, an emulator must be installed.

Android (Windows, macOS, Linux)

Android Studio is a good editor for running Flutter and comes with its own virtual devices for emulation.

iOS (macOS)

In order to run Flutter apps on iOS devices, you must use a macOS computer that has Xcode installed.

Installing Xcode

After installing Xcode, open the iOS emulator either by typing "Simulator" in Spotlight Search or by typing the line open -a Simulator in the terminal.

Collecting feedback

We used Wiredash.io to collect bug reports, feature wishes and make it easy for your users to get in touch with us. To join the application storage request an access by following the Wiredash link

Google integration

Firestore & Firebase

First, we create a database for particle integration. In this project, we use a firebase database because of its features.

  • Go to https://console.firebase.google.com/
  • Sign in with your google account
  • Click "Create Project"
  • Fill required information
  • Next, we create a collection in the Firestore database.
  • Press "START COLLECTION" and give it the name you want and press "SAVE"

Resources

SmartCar Platform

Flutter

https://dart.dev/ https://flutter.dev/docs

C++

https://www.geeksforgeeks.org/c-plus-plus/
https://www.cplusplus.com/

Overview

Get started

Features

Documentation

Clone this wiki locally