From 0a4ab8475eb49a20bd52809df092e34ca715f883 Mon Sep 17 00:00:00 2001 From: ztimson Date: Sun, 3 Dec 2023 18:59:10 -0500 Subject: [PATCH] Updated repo information --- .gitignore | 1 + LICENSE.txt | 11 ++++++ README.md | 77 ++++++++++++++++++++++++++++++++---- website/.circleci/config.yml | 33 ---------------- website/.gitignore | 45 --------------------- website/tsconfig.app.json | 10 +---- website/tsconfig.json | 10 ++++- 7 files changed, 93 insertions(+), 94 deletions(-) create mode 100644 LICENSE.txt delete mode 100644 website/.circleci/config.yml delete mode 100644 website/.gitignore diff --git a/.gitignore b/.gitignore index 2beacad..6fb8691 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .vscode node_modules +dist diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..6b3783a --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,11 @@ +Copyright (c) 2023 Zakary Timson + +All Rights Reserved. + +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. diff --git a/README.md b/README.md index ded2f9b..a9075ae 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,73 @@ -# HomeFront-Battery + +
+
-After obtaining 4 Tesla battery modules from a model X, a client and I decided to build our own knock off Tesla power wall and hook it up to a solar array to create an offgrid system. Part of this project was to log the voltage, battery tempature and control a set of fans through a website so it could be controleld and monitored remotely. + + Logo -We accomplished the software side in 3 steps: - - An arduino to log the raw data from sensors and transmit them over the serial port (See the arduino.ini file) - - A raspberry pi to recieve the serial data and send it to the cloud DB (See the monitor.js file) - - [A website to display the recorded data live](https://github.com/ztimson/HomeFront) + + ### HomeFront - + + Simple repository template + + + [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/home-front/tags&query=$[0].name)](https://git.zakscode.com/ztimson/home-front/tags) + [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/home-front&query=open_pr_counter)](https://git.zakscode.com/ztimson/home-front/pulls) + [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/home-front&query=open_issues_count)](https://git.zakscode.com/ztimson/template/issues) + + --- +
+ +## Table of Contents +- [HomeFront](#top) + - [About](#about) + - [Built With](#built-with) + - [Setup](#setup) + - [Development](#development) + - [License](#license) + +## About + + + +After obtaining 4 Tesla battery modules, I was contracted to build a device to record battery voltages & temperatures. This was accomplished using some custom circutry and +an arduino. These input values were then read by a Raspberry Pi & published to a web UI for remote viewing. + +Later on the arduino was removed and the raspberry pi was directly interfaced with an upgraded Battery Charging Module which was able to read values directly from the batteries +onboard computer. + +The code is split into two pieces: + - Website for viewing data + - Arduino & Raspberry Pi code to collect & publish battery data + +### Built With +[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) +[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/) +[![Firebase](https://img.shields.io/badge/Firebase-FFFFFF?style=for-the-badge&logo=firebase)](https://firebase.google.com/) +[![Shell](https://img.shields.io/badge/Shell-000000?style=for-the-badge&logo=windowsterminal&logoColor=00ff00)](https://en.wikipedia.org/wiki/Shell_script) +[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) + +## Setup + +
+ +

+ Development +

+ + +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) + +#### Instructions +1. Install the dependencies: `npm install` +2. Start the Angular server: `npm run start` +3. Open [http://localhost:4200](http://localhost:4200) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information. diff --git a/website/.circleci/config.yml b/website/.circleci/config.yml deleted file mode 100644 index f8bf87c..0000000 --- a/website/.circleci/config.yml +++ /dev/null @@ -1,33 +0,0 @@ -version: 2 -jobs: - build: - docker: - - image: circleci/node:12.14-browsers - - working_directory: ~/repo - - steps: - - checkout - - - restore_cache: - keys: - - v1-dependencies-{{ checksum "package.json" }} - - v1-dependencies- - - - run: - name: Install Dependancies - command: yarn - - - save_cache: - key: v1-dependencies-{{ checksum "package.json" }} - paths: - - node_modules - - functions/node_modules - - - run: - name: Build - command: npm run build - - - run: - name: Deploy - command: npm run deploy diff --git a/website/.gitignore b/website/.gitignore deleted file mode 100644 index de51f68..0000000 --- a/website/.gitignore +++ /dev/null @@ -1,45 +0,0 @@ -# See http://help.github.com/ignore-files/ for more about ignoring files. - -# compiled output -/dist -/tmp -/out-tsc -# Only exists if Bazel was run -/bazel-out - -# dependencies -/node_modules - -# profiling files -chrome-profiler-events*.json - -# IDEs and editors -/.idea -.project -.classpath -.c9/ -*.launch -.settings/ -*.sublime-workspace - -# IDE - VSCode -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json -.history/* - -# misc -/.sass-cache -/connect.lock -/coverage -/libpeerconnection.log -npm-debug.log -yarn-error.log -testem.log -/typings - -# System Files -.DS_Store -Thumbs.db diff --git a/website/tsconfig.app.json b/website/tsconfig.app.json index 82d91dc..c96c919 100644 --- a/website/tsconfig.app.json +++ b/website/tsconfig.app.json @@ -2,14 +2,8 @@ { "extends": "./tsconfig.json", "compilerOptions": { - "outDir": "./out-tsc/app", + "types": [] }, - "files": [ - "src/main.ts", - "src/polyfills.ts" - ], - "include": [ - "src/**/*.d.ts" - ] + } diff --git a/website/tsconfig.json b/website/tsconfig.json index 0418b1d..2bd5f59 100644 --- a/website/tsconfig.json +++ b/website/tsconfig.json @@ -4,7 +4,8 @@ "compilerOptions": { "allowSyntheticDefaultImports": true, "baseUrl": "./", - "outDir": "./dist/out-tsc", +// "outDir": "./dist/out-tsc", + "outDir": "./out-tsc/app", "forceConsistentCasingInFileNames": true, "strict": true, "noImplicitReturns": false, @@ -25,6 +26,13 @@ "dom" ] }, + "files": [ + "src/main.ts", + "src/polyfills.ts" + ], + "include": [ + "src/**/*.d.ts" + ], "angularCompilerOptions": { "enableI18nLegacyMessageIdFormat": false, "strictInjectionParameters": true,