smearor

Smearor - A modular, flexible and resource friendly software for smart mirrors with touch functionality

Goals

• Resource friendly (low memory footprint) by using rust and tauri
• Modular - Add new functionality with addons
• Touch-enabled - You can navigate with touch gestures

Requirements

The project focus is on touch enabled mirrors.

Hardware Requirements

• Touch Display with touch-through-glass functionality (List of possible displays)
• Dielectric spy mirror glass (List of possible spy mirror glasses)
• A mini computer like the Raspberry Pi 5

Software Requirements

• Linux / Raspberry Pi OS
• Wayland
• Gnome
• This software: Smearor

Hardware

Step 1: Touchscreen

:desktop_computer: Recommended Monitors

Step 2: Raspberry Pi 5

:mirror: Step 3: Spy Mirror

Recommended Spy Mirror Glass

Step 4: Frame

Optional Hardware

HifiBerry MiniAMP

DHT13 Sensor

Raspberry Pi Camera Module 3

Features

Data Model

• Components
• Entity Types
• Relation Types

Data Instances

• Entity Instances
• Relation Instances

Control Flow

• Flow Types
• Flow Instances

User Interface

• Declarative User Interface
  • Declarative Layers & Layouts
  • Declarative Widgets

Interface

• GraphQL

Addons

List of core addons

Plugin Compliments

This module displays a random compliment.

Screenshot

Usage

How to add the plugin.

Configuration

How to configure the plugin.

Plugin Clock

This module displays a clock.

Screenshot

Usage

How to add the plugin.

Configuration

How to configure the plugin.

Addon Development

Goal is to make as much as possible low code.

Functionality

• Provide assets (Images, CSS, JavaScript, Fonts)
• Provide widgets
• Provide data models
  • Components
  • Entity Types
  • Relation Types
• Provide data sources
  • HTTP
  • MQTT
  • GraphQL
• Provide data sinks
  • HTTP
  • MQTT
  • GraphQL
• Provide control flow logic
  • Flow Types
  • Flow Instances

Architecture

Data Flow (Output)

1. Data Source -> Entity -> GraphQL -> Widget Content
2. Data Source -> Entity -> Flow -> Entity -> GraphQL -> Widget Content

Data Flow (Input)

1. Widget Action -> GraphQL -> Entity
2. Widget Action -> GraphQL -> Entity -> Flow
3. Widget Action -> GraphQL -> Entity -> Data Sink
4. Widget Action -> GraphQL -> Entity -> Flow -> Entity -> Data Sink

Data Flow (InOut)

1. Widget Action -> GraphQL -> Entity -> Flow -> Entity -> GraphQL -> Widget Content
2. Widget Action -> GraphQL -> Entity -> Flow -> Data Sink -> Data Source -> Entity -> GraphQL -> Widget Content

Architecture

Used technologies

• Tauri
• Reactive Graph Flow
• widget.json
• ...

Design System

Two-way-mirror specific design goals

• Backgrounds have to be black

Open Props

• Expertly crafted web design tokens
• Create consistent components
• Useful in any framework

@import "https://unpkg.com/open-props";

Fonts

Roboto is the default font.

Building

Linux

Ubuntu / Raspberry Pi OS

sudo apt install libgtk-3-dev libjavascriptcoregtk-4.1-dev libsoup-3.0-dev libwebkit2gtk-4.1-dev

Run Dev Mode

cd modules/smearor
pnpm run tauri dev

Build in Release Mode

cargo build --release

Keen users can opt into multi-threaded mode with the -Z threads option:

RUSTFLAGS="-Z threads=8" cargo build --release

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.1.0] - Unreleased

Added

• Default font: Roboto (Apache License)
• Initial book

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

• The use of sexualized language or imagery and unwelcome sexual attention or advances
• Trolling, insulting or derogatory comments, and personal or political attacks
• Public or private harassment
• Publishing others' private information, such as a physical or electronic address, without explicit permission
• Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@smearor.io. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

MIT License

Copyright (c) 2024 Andreas Schaeffer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.