If you do not already have a running Kubernetes, you can start one with (one of) the options:
- Laptop: Docker Desktop (recommended), Minikube, Kind, k3s
- Cluster: Kops (on EC2)
- Managed service: EKS/AKS/GKE
- Other distribution: Rancher, OpenShift
⚠️ If you are on Minikube: We are working to resolve a known issue with Minikube (see #30) that is causing errors when running digis.
Install Kubernetes CLI kubectl and package manager helm 3.
- Run
kubectl cluster-infoto confirm the Kubernetes is running.
Digi:
-
Clone the repo https://github.com/digi-project/digi to
$GOPATH/src/digi.dev. -
Run the follwing commands:
make dep && make digi digiYou should see a list of command provided by digi.
Start the dSpace: digi space start
If you plan to contribute to Digi, please check out development guide.
Download example digis
- Mocks: https://github.com/digi-project/mocks
- This repo includes digis that simulate individual devices (i.e. mocks such as a mock lamp) and contexts (i.e. scenes such as a room). Information about how to use and configure these mocks and scenes can be found in the digibox paper.
- Apps: https://github.com/digi-project/examples
- Includes example apps, e.g., a lamp digivice that controls a mock lamp or a physical lamp.
You can use the examples to validate digi is set up correctly:
- Ensure Kubernetes is running:
kubectl get pods. - Ensure all dSpace controllers (i.e., meta digis) are running:
digi space start. - In /mocks, run
digi run lamp l1anddigi check l1.
You should be able to see the lamp l1's model. See "Frequently used commands" section for additional commands you can use to interact with the digi.
For demos:
- Demos (optional): https://github.com/digi-project/demo
- Includes demos for end-to-end applications, e.g., for building monitoring.
- Recorded demos (optional): https://github.com/digi-project/recording
- Includes pre-recorded app demos.
TBD command table