Unum SDK

Minim is an AI-driven smart home WiFi managment and security platform that offers IoT fingerprinting, security, managment, as well as operator and subscriber APIs that can be leveraged to build custom services. All of this is enabled by the Unum Agent which runs on the home gateway.

This repository contains the open source distribution of Minim's Unum agent and related libraries as well as build scripts and reference code, cumulatively known as the Unum SDK.

Technical Background

Unum is a cross-platform C program designed for Linux and can be built and installed on OpenWrt-compatible devices, Asus MAP AC1300, Asus MAP AC1700 as well as Linux x86_64, i386, and armhf architectures.

I am a...

...router manufacturer and want to port the agent to my device.

First, you should familiarize yourself with the requirements for the agent and the information you'll need to know to begin integrating the agent with your platform. You can review the following documents to understand the detailed requirements.

• System and Hardware Requirements
• Integrator Information Checklist

After confirming that you have everything you need and that the device meets all requirements, clone the agent code and review one of the reference implementations (such as Asus AC1300).

Once familiar with the source layout and with the platform specific functions that are required, you can follow the Integration Guide that Minim developers use to support new platforms.

...hobbyist and want to setup minim on my own my device.

Running the Unum agent requires a Minim Labs developer account. Sign up for an account on the Minim website.

The Unum agent is designed to operate on a network gateway device or wireless access point. Once installed, link your device with the Minim cloud to begin gaining insight into your network.

• Read the "Integration Document and Build the SDK yourself for these supported platforms:
  • OpenWRT: build Unum for LEDE / OpenWRT distributions
  • Asus MAP AC1300: build Unum for Asus MAP AC1300 Router
  • Asus MAP AC1700: build Unum for Asus MAP AC1700 Router
  • Linux: build Unum for Linux and Linux-like distributions
  • Docker: run a Linux router with Unum in a Docker container
• For guides and documentation, check out the Unum SDK wiki.

...developer at Minim.

For the step by step instructions for adding new hardware kinds, running unit tests, details on how to add the new hardware kind to the cloud as well as details about how to setup new automated builds, take a look at the instructions here:

Minim Developer Gude

Contributing

Guidelines around contributing to Unum SDK are outlined in CONTRIBUTING.md.

Check the Developer Guide on the wiki for more information on the technical aspects of the SDK.

Get in touch

The Minim team is always happy to chat. Send us a mail at [email protected] or visit our website to find out more!