Smart KotKot Module

Installation

Clone this repository on your chicken's server with the following command :

git clone https://github.com/Sylchauf/smart-kotkot.git

Then, install the following requirements.

Requirements

• Docker (Installation)
• Docker-compose (Installation on x64/x86 or Installation on raspbian)

Run

docker-compose up

Your module is now live at http://YOUR_LOCAL_IP:3000

Configuration

Smart KotKot configuration is in the /state directory and is composed of multiples files :

• config.json is the general configuration file. Clone the sample file in the /state_sample directory and edit it before running the application. All configurations properties is described in Config properties
• doorState.json is the door configuration file. It stores the state of the door (open / close) and the times needed to open and close the door (in seconds). You must write yourself the first state in this file and the time in seconds to open and close the door. Clone the sample file in the /state_sample directory and edit it. All configurations properties is described in Door State properties
• lightState.json is the light configuration file. It stores the state of the light (on or off) and you must write yourself the first state in this file. Clone the sample file in the /state_sample directory and edit it. All configurations properties is described in Light State properties

API

Door

Open and close the door

Moves the door up or down.

• GET /api/door/up Open the door entirely
• GET /api/door/down Close the door entirely

Calibration

To initialize your door state, or if the door is not entirely open/closed, small correction movements can be fired.

• GET /api/door/calibrate/up Move up the door for config.door.correctionSecs (default is 1s)
• GET /api/door/calibrate/down Move down the door for config.door.correctionSecs (default is 1s)

Status

• GET /api/door/status Get the state of the door

Camera

List all cameras

Get an array of all initialized camera

• GET /api/camera/list

Get images

Access to pictures taken by cameras. Replace {CAMERA_ID} by the id given in the camera list endpoint Replace {IMAGE_ID} by the id given in the images list endpoint

• GET /api/camera/images/{CAMERA_ID}/list Get a list of all images taken.
• GET /api/camera/images/{CAMERA_ID}/last Get the last picture taken by this camera
• GET /api/camera/images/{CAMERA_ID}/{IMAGE_ID}
• GET /api/camera/capabilities/{CAMERA_ID} Get the capabilities of this camera

Take pictures

Take a picture on the selected camera. Replace {CAMERA_ID} by the id given in the camera list endpoint

• GET /api/camera/images/{CAMERA_ID}/take Get a list of all images taken.

Light

Turn on and off

• GET /api/light/on Turn the light on
• GET /api/light/off Turn the light off

Status

• GET /api/light/status Get the state of the light

Troubleshooting

Give USB access to get data from TEMPerHUM

echo 'SUBSYSTEM=="usb", MODE="0660", GROUP="plugdev"' > /etc/udev/rules.d/00-usb-permissions.rules
udevadm control --reload-rules

Developers

Rebuild and push the image

docker buildx build --platform linux/arm/v6,linux/arm/v7,linux/amd64,linux/arm64 -t sylchauf/smart-kotkot-module:latest --push .