Kocheda Icon Repository

Overview

This project contains a set of icons which can be dropped into other projects to provide graphical UI. It is not intended to be a competitor to font-awesome etc it is just a repository of themed icons.

It can be run to start a webserver which can be used to GET the icons, theme JSON and registry JSON.

Guide

When adding icons:

• Ensure the icon is populated for each theme
• Generate the LCD icons using the script
• Icons should all be consistent size in their set

LCD Icons

Generating LCD icons can be done by using the 'pixel-icon.html' script and then copying the output into the lcd-source/source.json file.

Then run:

node generate-lcd-icons.js <theme>

node generate-lcd-icons.js tlcd
node generate-lcd-icons.js glcd

Which will generate all the icons from lcd-source/source.json and put them in the relevant icons/theme folders

Web Server

Using npm start the index.js script will start up a web server which provides 3 end points:

• /themes - Return the icons/themes.json file as application/json
• /registry - Return the icons/registry.json file as application/json
• /{theme}/{category}/{icon} - Return an icon as image/png (eg /kocheda/application/alarm)

Once running any service can access an image using standard HTTP GET request, eg:

curl http://localhost:8077/kocheda/application/alarm --output alarm.png

Configuration

The default web server port is 8077 but this can be changed in settings.json