Téléverser les fichiers vers "/"

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Current version
+- add step increment mode. Increment can be set in config menu
+- add scan feature in step increment mode.
+
+## 2.1.0 - 2019-08-17
+- enable FI in Rx CW
+- change DDS's PLL frequency
+- add clarifier offset feature
+
+## 2.0.0 - 2019-07-29
+- add RX clarifier feature
+- add VFO offset feature
+- add S-meter feature
+- heavy refactorisation to introduce application modes config/cibi/transverter
+- roll back to Adafruit si5351, modified to enable/disable output one by one
+
+## 1.1.0 - 2019-05-14 (etherkit si5351)
+- change si5351 library for one supporting: si5351B + allowing to select output one by one:
+https://github.com/etherkit/Si5351Arduino
+
+## 1.0.0 - 2019-05-02 (first stable version)
+- initial creation

LICENSE.md

@@ -0,0 +1,26 @@
+```
+Copyright (c) 2019, Vincent Hervieux vincent.hervieux@gmail.com
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of the author Vincent Hervieux, nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```

README.md

@@ -1,3 +1,151 @@
-# VFO-DDS-CB
+This Arduino code aims to drive a DDS and a Display in order to replace analog oscillators in old citizen band  transceivers.
+
+# Parts
+- [Arduino nano R3](doc/nano.png) with new bootloader (optiboot_atmega328.hex)
+- OLED display SSD1306 128x64 0.96" IIC
+- a Rotary encoder with button
+- A DDS [si5351A](doc/Si5351-B.pdf) (3 outputs)
+
+# Principles
+## Basic principles
+A rotary encoder with button is used.
+- turning the encoder will adjust the frequency.
+- clicking the encoder button will change the frequency step
+
+Below it the working principle:
+
+```mermaid
+graph TD;
+A[Start]-->B(Setup display);
+B-->C(Setup pin);
+C-->D(Setup DDS);
+D-->E{Loop - Key press interrupt?}
+E-->|interrupt|F(Update Display)
+F-->G{Freq. changed?}
+G-->|No|E
+G-->|Yes|H(Update DDS)
+H-->E
+```
+## Advanced explanations
+
+- Modulation is read from the modulation selector and wired to D8, D9, D10, D11, D12 in order to adjust VFO and FI depending on the modulation type. This is mainly because of USB and LSB modes with are requiring +/- 2.5kHz shifts.
+- TX is read from the mike plug on D5 to activate the FI oscillator upon TX only.
+- The old band selector is re-used to switch between : 
+* configuration mode (wired to D6).
+* transverter mode (wired to D7) : TO BE DONE, for now tranceiver mode as below.
+* tranceiver mode which is the default mode when neither D6 and D7 are selected
+- finally a small S-meter is implemented using analog input A3
+- a RX clarifier is built reusing front potentiometers
+- an "increment" mode is built when setting 'CH9' on the front panel. In this tranceiver mode, step is always 5kHz, and pressing the rotary button performs a scan search. When a strong signal is found, the scan stops.
+
+# Compilation
+
+## Retrieve the source code using git
+
+git clone git@gitlab.com:croutor/arduino-cibi-vfo.git
+
+cd arduino-cibi-vfo
+
+git submodule update --init --recursive
+
+## Retrieve the source code without git
+
+Download https://gitlab.com/croutor/arduino-cibi-vfo/-/archive/develop/arduino-cibi-vfo-develop.zip
+
+Unzip it
+
+Download https://github.com/pavelmc/Si5351mcu/archive/refs/heads/master.zip
+
+Unzip it in arduino-cibi-vfo/lib/Si5351mcu 's folder
+
+## IDE setup
+
+This project is using [Microsoft Visual Studio Code](https://code.visualstudio.com/) with [PlatformIO IDE](https://platformio.org/platformio-ide)'s plugin.
+
+## Building
+
+Terminal -> Run Task ->PlatformIO: Build
+
+## Upload on arduino
+
+Terminal -> Run Task ->PlatformIO: Upload
+
+# Wiring
+Referring to [vfo.h](/include/vfo.h) and [input.cpp](/src/input.cpp):
+* D12 = INPUT CW (active high or low depending on compilation flag INPUT_MODULATION_ACTIVE_HIGH)
+* D11 = INPUT AM (active high or low depending on compilation flag INPUT_MODULATION_ACTIVE_HIGH)
+* D10 = INPUT FM (active high or low depending on compilation flag INPUT_MODULATION_ACTIVE_HIGH)
+* D9 = INPUT USB (active high or low depending on compilation flag INPUT_MODULATION_ACTIVE_HIGH)
+* D8 = INPUT LSB (active high or low depending on compilation flag INPUT_MODULATION_ACTIVE_HIGH)
+* D7 = (Unused) TRANSVERT MENU (active low)
+* D6 = CONFIG MENU (active low)
+* D5 = TX (active low)
+* D4 = button pin (active low)
+* D3 = Rotary encoder A pin
+* D2 = Rotary encoder B pin
+* A1 = Step/increment mode (active low)
+* A2 = clarifier input (analog 0-5V)
+* A3 = s-meter input (analog 0-5V)
+* A4 = IIC SDA
+* A5 = IIC SCL
+
+DDS output on si5351:
+* FI(10.695MHz+/-2.5kHz) = CLK0
+* VFO(var) = CLK2
+
+![Schematic](img/schematic.png)
+
+# Display
+Main menu:
+![Main menu](img/main_menu.jpg)
+Main menu step frequencies:
+![Main menu frequency step](img/main_menu_freq_step.jpg)
+Main menu changing frequencies by digit:https://code.visualstudio.com/
+
+Configuration menu aims to adjust some user settings / adjustements:
+![Config menu 01](img/config_menu_01.jpg) 
+![Config menu 02](img/config_menu_02.jpg) 
+![Config menu 03](img/config_menu_03.jpg) 
+![Config menu 04](img/config_menu_04.jpg) https://github.com/pavelmc/Si5351mcu/archive/refs/heads/master.zip
+
+
+# Demo
+
+Video explaining the project
+
+[![Video demo](https://img.youtube.com/vi/91tv6xmkw9M/0.jpg)](https://www.youtube.com/watch?v=91tv6xmkw9M)
+
+# Integration in a Superstar 360 FM
+
+C107 is unplugged from the TR26 emitter first. And then the DDS VFO output is connected to the base of TR27 via the C107 capacitor.
+
+The X4 quartz (10.695MHz) is removed and the DDS FI output is connected to the base of TR30 via an additionnal 10pF capacitor.
+
+TX input has to be connected to the pin of the microphone plug which is grounded while transmitting.
+
+Increment input is connected to the CH9 switch.
+
+Band selector is diconnected from the main board. Its center is grounded. Config's in put is connected to B and Transvert's input is connected to C.
+
+Note that Transvert mode is UNUSED as it is not implemented, so finally you could also wire: Nothing on A, Config on B, and Increment on C.
+
+S-meter input is connected on the Smeter (of course), on the S507 switch side.
+
+Clarifier potentiometers (fine and coarse) are totally disconnected from the main board, and rewired as shown in the schematic
+
+![Clarifier](img/clarifier.png)
+
+For the modulations, you need to connect D8, D9, D10, D11, D12 to the cibi tranceiver's modulation selector. Resistors bridges are protecting the inputs from the 8Volts.
+
+# Credits
+
+This project is using some external libraries:
+
+- [U8G2 for the diplay](https://github.com/olikraus/u8g2)
+
+- [Si5351mcu to Drive the DDS](https://github.com/pavelmc/Si5351mcu)
+
+- [ClickEncoder for the rotary encoder](https://github.com/soligen2010/encoder)
+
+- [TimerOne](https://playground.arduino.cc/Code/Timer1/)
 
-VFO pour Citizen Band

platformio.ini

@@ -0,0 +1,20 @@
+
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:uno]
+platform = atmelavr
+board = nanoatmega328new
+framework = arduino
+build_flags = -Wall
+lib_deps = 
+	ClickEncoder
+	TimerOne
+	olikraus/U8g2@^2.32.15