# techyscientist/bscproject architecture

> Architecture diagram of the GitHub repository techyscientist/bscproject, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/techyscientist/bscproject
- Repository: https://github.com/techyscientist/bscproject

## Overview

This repository is a BSc electronic orchestral-chime project combining PIC18 firmware and Java serial tools. The clearest user workflow is selecting a raw sound sample in the Java transmitter, then sending it over serial for loading into project memory. The tree also shows separate firmware experiments for DAC/RAM, display, timers, and serial communication. Firmware excerpts and project documentation are limited, so internal links beyond the demonstrated Java transfer are omitted rather than inferred.

Main entry points: [`ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java`](https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java) (Sample transmitter), [`SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java`](https://github.com/techyscientist/bscproject/blob/master/SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java) (Serial client), [`SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java`](https://github.com/techyscientist/bscproject/blob/master/SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java) (Serial server), [`ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java`](https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java) (Sine generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tools["Java tools"]
  node_transmit["Sample transmitter"]
  node_client["Serial client<br/>[SerialClient.java]"]
  node_server["Serial server<br/>[SerialServer.java]"]
  node_bytegen["Sine generator<br/>[MakeByteFile.java]"]
end

subgraph group_firmware["PIC firmware"]
  node_dacram["DAC and RAM<br/>[DAC-RAM.asm]"]
  node_filerx["File receiver<br/>[FileRX.asm]"]
  node_display["I2C display<br/>[density.asm]"]
  node_ledtimer["LED timer<br/>[LEDTimer.asm]"]
  node_projectcode["Chime firmware<br/>[ProjectCode.asm]"]
  node_interruptcounter["Serial interrupt counter"]
  node_echo["Serial echo<br/>[SerialRXEcho.asm]"]
  node_flip["Serial RX flip<br/>[SerialRXFlip.asm]"]
  node_tx["Serial TX<br/>[SerialTX.asm]"]
end

subgraph group_samples["Sound samples"]
  node_raw["Raw samples"]
end

node_user(("Operator"))
node_serial["Serial link"]

node_user -->|"selects file"| node_transmit
node_raw -->|"reads bytes"| node_transmit
node_transmit -->|"sends blocks"| node_serial
node_client -->|"sends commands"| node_serial
node_server -->|"reads commands"| node_serial
node_bytegen -->|"writes sine data"| node_raw
node_serial -->|"transfers sample"| node_filerx

click node_transmit "https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java"
click node_client "https://github.com/techyscientist/bscproject/blob/master/SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java"
click node_server "https://github.com/techyscientist/bscproject/blob/master/SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java"
click node_bytegen "https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java"
click node_dacram "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/DAC-RAM.X/DAC-RAM.asm"
click node_filerx "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/FileRX.X/FileRX.asm"
click node_display "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/I2CDisplay.X/density.asm"
click node_ledtimer "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/LEDTimer.X/LEDTimer.asm"
click node_projectcode "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/ProjectCode.X/ProjectCode.asm"
click node_interruptcounter "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialInterruptCounte.X/SerialInterruptCounter.asm"
click node_echo "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialRXEcho.X/SerialRXEcho.asm"
click node_flip "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialRXFlip.X/SerialRXFlip.asm"
click node_tx "https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialTX.X/SerialTX.asm"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_transmit,node_client,node_server,node_bytegen toneBlue
class node_dacram,node_filerx,node_display,node_ledtimer,node_projectcode,node_interruptcounter,node_echo,node_flip,node_tx toneAmber
class node_raw toneMint
class node_user,node_serial toneIndigo
```

## Components

### Java tools

- [Sample transmitter](https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java): `ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java`
- [Serial client](https://github.com/techyscientist/bscproject/blob/master/SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java): `SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java`
- [Serial server](https://github.com/techyscientist/bscproject/blob/master/SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java): `SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java`
- [Sine generator](https://github.com/techyscientist/bscproject/blob/master/ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java): `ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java`

### PIC firmware

- [DAC and RAM](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/DAC-RAM.X/DAC-RAM.asm): `MPLABProjects/DAC-RAM.X/DAC-RAM.asm`
- [File receiver](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/FileRX.X/FileRX.asm): `MPLABProjects/FileRX.X/FileRX.asm`
- [I2C display](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/I2CDisplay.X/density.asm): `MPLABProjects/I2CDisplay.X/density.asm`
- [LED timer](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/LEDTimer.X/LEDTimer.asm): `MPLABProjects/LEDTimer.X/LEDTimer.asm`
- [Chime firmware](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/ProjectCode.X/ProjectCode.asm): `MPLABProjects/ProjectCode.X/ProjectCode.asm`
- [Serial interrupt counter](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialInterruptCounte.X/SerialInterruptCounter.asm): `MPLABProjects/SerialInterruptCounte.X/SerialInterruptCounter.asm`
- [Serial echo](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialRXEcho.X/SerialRXEcho.asm): `MPLABProjects/SerialRXEcho.X/SerialRXEcho.asm`
- [Serial RX flip](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialRXFlip.X/SerialRXFlip.asm): `MPLABProjects/SerialRXFlip.X/SerialRXFlip.asm`
- [Serial TX](https://github.com/techyscientist/bscproject/blob/master/MPLABProjects/SerialTX.X/SerialTX.asm): `MPLABProjects/SerialTX.X/SerialTX.asm`

### Sound samples

- **Raw samples**

### Other components

- **Operator**
- **Serial link**

## Connections

- Operator → Sample transmitter: selects file (evidence: `ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java`)
- Raw samples → Sample transmitter: reads bytes (evidence: `ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java`)
- Sample transmitter → Serial link: sends blocks (evidence: `ProjectFileTX/src/net/johnnyconsole/project/serial/SerialFileTransmit.java`)
- Serial client → Serial link: sends commands (evidence: `SerialClient/src/net/johnnyconsole/project/serial/client/SerialClient.java`)
- Serial server → Serial link: reads commands (evidence: `SerialServer/src/net/johnnyconsole/project/serial/server/SerialServer.java`)
- Sine generator → Raw samples: writes sine data (evidence: `ProjectFileTX/src/net/johnnyconsole/project/MakeByteFile.java`)
- Serial link → File receiver: transfers sample
