Giter Site home page Giter Site logo

techtalkzach / mmm-spectraai Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jongan69/mmm-spectraai

1.0 0.0 0.0 51 KB

Spectra AI is a module application that is designed to integrate with MagicMirror, an open-source smart mirror platform. It allows users to interact with OpenAI's powerful language model, GPT, by hardcoding a prompt, sending it to the OpenAI API, and then displaying the result on the smart mirror.

License: MIT License

JavaScript 100.00%

mmm-spectraai's Introduction

MMM-spectraAI

Spectra AI is a module application that is designed to integrate with MagicMirror, an open-source smart mirror platform. It allows users to interact with OpenAI's powerful language model, GPT, by hardcoding a prompt, sending it to the OpenAI API, and then displaying the result on the smart mirror. alt text

Requierments

This module is to be used with the MagicMirror project, so it assumes you have a working MagicMirror set up and running already. There is a great community for this project on places like Reddit and also the MagicMirror Forums if you need help with getting started. There is also great documentation if you'd like to get started building your own module.

SET UP Windows:

To get the MagicMirror software running on Windows, you have to do two things in addition to the steps above:

 cd MagicMirror
  • Install dependencies in the vendor and font directories:

Powershell:

cd fonts; npm install; cd ..
cd vendor; npm install; cd ..

Command Prompt:

cd fonts && npm install && cd ..
cd vendor && npm install && cd ..

Otherwise the screen will stay black when starting the MagicMirror.

  • Fix the start script in the package.json file:

Navigate to the file package.json Find where it says

"start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
"start:dev": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js dev",

and replace it with

"start": ".\\node_modules\\.bin\\electron js\\electron.js",
"start:dev": ".\\node_modules\\.bin\\electron js\\electron.js dev",

Otherwise the program won't start, but will display this error message: "'DISPLAY' is not recognized as an internal or external command, operable program or batch file."

Set up PI

 cd MagicMirror

Install MagicMirror dependencies

sudo npm install

Verify it starts

npm start

Navigate out of the MagicMirror folder

cd ..

Navigate into your MagicMirror's modules

cd MagicMirror/modules

Clone this repository (MMM-SpectraAI)

https://github.com/nimius-debug/MMM-spectraAI
npm start
npm run start:dev

Config

Open your config file in config/config.js and add the module to the modules array like so:

modules: [
    ...Other Modules Here...,
    {
        module: 'MMM-spectraAI',
        position: "bottom_left",
            //optional config 
            config: {
                OPENAI_API_KEY: "YOUR API KEY",
                DEEPGRAM_API_KEY: "YOUR API KEY",
                DG_ENDPOINT: 'wss://api.deepgram.com/v1/listen',
            //   updateInterval: 60 * 60 * 1000, // update every hour
            },
    }
]

mmm-spectraai's People

Contributors

nimius-debug avatar

Stargazers

Roman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.