https://github.com/bradenn/udap

UDAP (Universal Device Aggregation Platform) provides a unified interface for aggregating various disjoint components.
https://github.com/bradenn/udap

aggregation control devices golang home modular modules smarthome udap

Last synced: 23 days ago
JSON representation

UDAP (Universal Device Aggregation Platform) provides a unified interface for aggregating various disjoint components.

• Host: GitHub
• URL: https://github.com/bradenn/udap
• Owner: bradenn
• License: other
• Created: 2019-12-29T01:21:25.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T03:28:06.000Z (almost 2 years ago)
• Last Synced: 2024-04-23T06:48:31.175Z (almost 2 years ago)
• Topics: aggregation, control, devices, golang, home, modular, modules, smarthome, udap
• Language: Vue
• Homepage:
• Size: 39 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# UDAP v2.18.6

[![Go](https://github.com/bradenn/udap/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/bradenn/udap/actions/workflows/go.yml)

[![Go CodeQL](https://github.com/bradenn/udap/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/bradenn/udap/actions/workflows/codeql-analysis.yml)

[![Typescript](https://github.com/bradenn/udap/actions/workflows/ts.yml/badge.svg)](https://github.com/bradenn/udap/actions/workflows/ts.yml)

## Universal Device Aggregation Platform

Udap aims to efficiently link and aggregate many unlike interfaces into a heuristic model that can be manipulated and

supplemented from add-on plugins called modules. These modules are written in go and compile during Udap's runtime.

Modules can be configured to control computer settings, lights, music, air conditioners, phone systems, access points,

media, or even spaceships.

## Local Domain Configurations

Udap uses a certificate signed by its own certificate authority. New devices need to install a CA root certificate in

order to access the UDAP platform.

**Routing & Network Details**

## Entities & Attributes

Any state within udap is stored within an attribute. These attributes belong to a parent entity.

An example:

You have a smart light bulb. It has two settings through it's api (which you've linked via a module), brightness and

color hue. Each of these settings becomes its own attribute. The smart bulb is represented as an entity who's 'id' is

linked to the aforementioned attributes.

Another examples:

You want to connect spotify to udap. Spotify's API has a lot of options, but we can just focus two attributes:

isPlaying and currentSong. First you create an entity to represent the api, then you create and provide channels for

resolving each attribute's status.

## Glossary

| Phrase   | Description                                                                                    |

|----------|------------------------------------------------------------------------------------------------|

| UDAP     | Universal Device Aggregation Platform (encompasses all below terms)                            |

| Core     | The primary UDAP program instance, though there can be multiple core instances.                |

| Terminal | An authoritative udap interface instance (Used for configuration, management, and primary use) |

| Mobile   | The general purpose mobile app used for interacting with the UDAP platform.                    |

### Terminal Screenshots

This is not an exhaustive list of UDAP's applications and configurations. There are more than sixty views in total.

A screenshot of the terminal unlocked screen as of v2.15.1. (With the background blur setting enabled)

![HomeScreen](./docs/images/home_2.15.1.png)

### Terminal Settings

#### Module page

This page allows an authenticated user to manage and monitor the runtime of UDAP's modules.

![SettingsModules](./docs/images/settings_modules.png)

#### Terminal App Examples

The sentry app controls a ceiling-mounted laser used for entertaining cats. The interface provides realtime positioning

on of the beam, and allows for manual targeting and attenuation.   (With BG blur setting disabled)

![SentryApp](./docs/images/app_sentry.png)

#### Exogeology App

The exogeology app uses data from NOAA to display near-live images of the Earth and the Sol (the sun).

##### Earth Page

![ExoGeoEarth](./docs/images/app_exogeo_earth.png)

##### Sol Page

![ExoGeoSol](./docs/images/app_exogeo_sol.png)

#### Basic Utility Apps

##### Calculator App

![Calculator](./docs/images/app_calculator.png)

## Front-end elements

#### Element

An element is a super class of a Plot, Pane, or other ui element that has a blurred background.

### Plots

A Plot is a grid-like element that contains a fixed number of cells defined by a number of rows and columns.

Plots can be configured to have a title and alt button. Plots are usually used to hold buttons or other contextual

elements.

##### Plot Selection (from Settings->Preferences page)

![Plot Buttons](./docs/images/plot_buttons.png)

##### Plot Module (from Settings->Modules page)

Plots can contain custom dom to serve whatever purpose is needed:

![Plot Buttons](./docs/images/plot_module.png)

##### Plot Buttons (from Global context Menu)

Plots are best used for providing many buttons for easy selection.

![Plot Buttons](./docs/images/plot_multi.png)

#### Utilities

Line Count

```git ls-files ./**/*.go ./**/*.vue ./client/src/**/*.ts ./embeded/**/*.cpp ./embeded/**/*.h ./embeded/**/*.c ./pkg/**/*.py ./client/**/*.scss | xargs wc -l```

`> 46603`

#### Copyright © 2019-2022 Braden Nicholson