From 57fa6be11030c7f0738d887ec82d79ef9145fb3a Mon Sep 17 00:00:00 2001 From: Logan Cusano Date: Sat, 22 Jul 2023 03:34:37 -0400 Subject: [PATCH] Update Readmes (sort of) --- Client/readme.md | 2 -- readme.md | 59 ++++++++++++++++++++++++++++-------------------- 2 files changed, 35 insertions(+), 26 deletions(-) diff --git a/Client/readme.md b/Client/readme.md index ec2e6e0..77c2d40 100644 --- a/Client/readme.md +++ b/Client/readme.md @@ -7,8 +7,6 @@ Explanation here ## Requirements --- - -Requirements here (not modules, that will be installed with npm) ### Hardware - SBC diff --git a/readme.md b/readme.md index e77d47b..de8bc5b 100644 --- a/readme.md +++ b/readme.md @@ -1,32 +1,43 @@ -# Discord Radio Bot: Command & Control +# Project Overview + +This project is a multi-layered application consisting of client and server applications. Its main purpose is to enable the use of Software-Defined Radios (SDRs) and Raspberry Pi (or similar Single Board Computers) to listen to radio frequencies in Discord voice channels. The project is designed to provide a seamless integration between the SDR hardware and the server with Discord commands. + +## Server Application + +The server application acts as the central hub within Discord, providing various functionalities and serving as the main point of communication for the clients. Some of the key features and responsibilities of the server include: + +- **RSS Feed Updates**: The server periodically updates text channels with RSS feed updates, keeping users informed about the latest news or information. +- **Server Management Functions / User Requests**: The server includes management functions that allow administrators to control and configure various aspects of the server environment. Users can interact with the server through Discord commands, which range from requesting specific radio presets to updating RSS feeds. +- **API and Web Front End**: The server exposes an API and web front end, providing an interface to view and control all the online clients. This allows users to monitor and manage the available radio presets, as well as perform various administrative tasks. + +### Requirements +#### Software + +### Installation --- +## Client Application -Project overview here +The client application communicates with the server through the provided API. Each client instance waits for join requests sent by users through Discord. Once a join request is received, the client uses the SDR application to tune into the specified radio preset. It then establishes a connection to Discord, allowing users to listen to the selected radio preset in real-time. -## Requirements Overview +In addition to its interaction with the server, the client also has its own API and web application. This enables users to directly interface with the client, perform actions specific to the client application, and access relevant information about the connected SDR and radio presets. ---- +### Requirements +#### Hardware +- SBC + - [Orange Pi](https://www.amazon.com/dp/B0BN16ZLXB/r) + - [Raspberry Pi](https://www.canakit.com/raspberry-pi-4-4gb.html) + - [Rock Pi](https://www.okdo.com/us/p/okdo-rock-4-model-c-4gb-single-board-computer-rockchip-rk3399-t-arm-cortex-a72-cortex-a53/) +- SDR + - [Nooelec RTL-SDR v5 Bundle ](https://www.amazon.com/dp/B01GDN1T4S) + - [RTL-SDR Blog V3](https://www.amazon.com/dp/B0BMKB3L47) + - [Nooelec NESDR Mini](https://www.amazon.com/dp/B009U7WZCA) +- Proper Power Adapter (Sometimes comes in SBC Packs) +- SD Card (Sometimes comes in SBC Packs) -### Server Requirements -#### Server: Discord Bot Requirements -### Client Requirements -#### Client: Discord Bot Requirements +#### Software -## Server +### Installation ---- - -Explanation and overview here - -## Client - ---- - -Explanation and overview here - -## Discord Bot - ---- - -Explanation and overview here \ No newline at end of file +## Troubleshooting +Check the [wiki]()