tordnat / elevator-project

Elevator project for Real-time Programming TTK4145 at NTNU

Elevator project - TTK4145

Elevator project for Real-time Programming TTK4145 at NTNU. This a distributed program which is designed to handle multiple elevators on a network concurrently in a fail-safe manner.

Disclaimer: Our elevator does not handle new orders when disconnected from the network. This is due to the state only being transmit through UDP on the network, without any form of loopback. Introducing a form of local loopback on transmit messages, such as an additional go channel, would solve this issue and fulfil the elevator specification.

Evaluation: Code quality -9/9

Dependencies

This project requires the following dependencies to be installed on the host machine:

• elevatorserver or elevatorsimulator needs to be installed and in the path of the root user
• golang >= 1.21 For the distributed elevator program
• dmd D-lang compiler for the hall request assigner
• (Optional) ffmpeg for elevator music

Snippets: sudo apt install golang sudo apt install dmd

To build and install the hall_request_assigner run the following commands: chmod +x scripts/install_deps.sh ./scripts/install_deps.sh

Note: If DMD is not in apt sources, visit https://dlang.org/download.html for dmd download

Deployment

To deploy an instance of an elevator you only need to run: sudo ./scripts/create_and_start_elevatorservice.sh 1 Where the argument specifies the ID of that instance. The script does the following:

• Make a config directory ~/.config/elevator/
• build the elevator program and copy to ~/.config/elevator/
• Copy the template systemd service file [email protected] to /etc/systemd/system
• Start the elevatorserver
• Enable and start the service with given ID

You can use systemctl to stop, start or view the status of a running elevator:

sudo systemctl start elevator@1

sudo systemctl stop elevator@1

sudo systemctl status elevator@1

Un-deployment: Removing the elevator

To remove the elvatorservice and it's configuration files you can use the following command:

sudo ./scripts/stop_and_remove_elevatorservice.sh 1

"1" being the instance you want to remove.

Cloning the repository

Since we have git submodules you need to clone the repository recursively: git clone --recursive link.to.repo.git

Manual deployment

To deploy the elevator manually you can run the elevatorserver:

elevatorserver --port myport

and then run the elevator program:

go run main.go --id myid --port myport

This is not part of the deployment, but is useful for testing (we use systemd for resetting our system from fail states)