MMDVMHost-Private/README.md

These are the source files for building the MMDVMHost, the program that interfaces to the MMDVM or DVMega on the one side, and a suitable network on the other. It supports D-Star, DMR, P25 Phase 1, NXDN, and System Fusion on the MMDVM, and D-Star, DMR, and System Fusion on the DVMega.

On the D-Star side the MMDVMHost interfaces with the ircDDB Gateway, on DMR it can connect to BrandMeister, DMR+, HB Link, XLX or [DMRGateway](https://github.com/g4klx/DMRGateway) (to connect to multiple DMR networks at once) on System Fusion it connects to the YSF Gateway. On P25 it connects to the P25 Gateway.

It builds on 32-bit and 64-bit Linux as well as on Windows using Visual Studio 2017 on x86 and x64. It can optionally control various Displays. Currently these are:

- HD44780 (sizes 2x16, 2x40, 4x16, 4x20)
	- Support for HD44780 via 4 bit GPIO connection (user selectable pins)
	- Adafruit 16x2 LCD+Keypad Kits (I2C)
	- Connection via PCF8574 GPIO Extender (I2C)
- Nextion TFTs (sizes 2.4", 2.8", 3.2" and 3.5")
- TFT display sold by Hobbytronics in UK
- OLED 128x64 (SSD1306)
- LCDproc

The Nextion displays can connect to the UART on the Raspberry Pi, or via a USB to TTL serial converter like the FT-232RL. It may also be connected to the UART output of the MMDVM modem (Arduino Due, STM32, Teensy), or to the UART output on the UMP.

The HD44780 displays are integrated with wiringPi for Raspberry Pi based platforms.

The Hobbytronics TFT Display, which is a Pi-Hat, connects to the UART on the Raspbery Pi.

The OLED display needs a extra library see OLED.md

The LCDproc support enables the use of a multitude of other LCD screens. See the [supported devices](http://lcdproc.omnipotent.net/hardware.php3) page on the LCDproc website for more info.

This software is licenced under the GPL v2 and is intended for amateur and educational use only. Use of this software for commercial purposes is strictly forbidden.
Update a bit of documentation. 2018-01-17 19:06:37 +00:00			`These are the source files for building the MMDVMHost, the program that interfaces to the MMDVM or DVMega on the one side, and a suitable network on the other. It supports D-Star, DMR, P25 Phase 1, NXDN, and System Fusion on the MMDVM, and D-Star, DMR, and System Fusion on the DVMega.`
Initial commit 2016-01-14 18:45:04 +00:00
Add XLX and DMRGateway as supported DMR networks 2017-07-02 16:47:25 +00:00			`On the D-Star side the MMDVMHost interfaces with the ircDDB Gateway, on DMR it can connect to BrandMeister, DMR+, HB Link, XLX or [DMRGateway](https://github.com/g4klx/DMRGateway) (to connect to multiple DMR networks at once) on System Fusion it connects to the YSF Gateway. On P25 it connects to the P25 Gateway.`
Initial commit 2016-01-14 18:45:04 +00:00
Update for VS2017. 2017-09-22 19:15:02 +00:00			`It builds on 32-bit and 64-bit Linux as well as on Windows using Visual Studio 2017 on x86 and x64. It can optionally control various Displays. Currently these are:`
Updated README concerning displays 2016-04-22 09:37:22 +00:00
			`- HD44780 (sizes 2x16, 2x40, 4x16, 4x20)`
Update README.md to include HD44780 variations and HD44780 todo list 2016-06-27 19:21:22 +00:00			`- Support for HD44780 via 4 bit GPIO connection (user selectable pins)`
			`- Adafruit 16x2 LCD+Keypad Kits (I2C)`
			`- Connection via PCF8574 GPIO Extender (I2C)`
Add 2.8" Nextion to README.md 2016-09-29 20:46:30 +00:00			`- Nextion TFTs (sizes 2.4", 2.8", 3.2" and 3.5")`
Update README.md 2017-01-06 10:30:48 +00:00			`- TFT display sold by Hobbytronics in UK`
Added manual for oled driver installation 2016-05-10 16:04:50 +00:00			`- OLED 128x64 (SSD1306)`
Update README.md in main directory to include LCDproc can't believe I missed this one out when I wrote it! 2017-07-02 16:43:38 +00:00			`- LCDproc`
Updated README concerning displays 2016-04-22 09:37:22 +00:00
Update README.md 2017-01-06 10:30:48 +00:00			`The Nextion displays can connect to the UART on the Raspberry Pi, or via a USB to TTL serial converter like the FT-232RL. It may also be connected to the UART output of the MMDVM modem (Arduino Due, STM32, Teensy), or to the UART output on the UMP.`
Update the README including the no commercial use section. 2016-01-25 22:34:41 +00:00
Update README.md 2017-01-06 10:30:48 +00:00			`The HD44780 displays are integrated with wiringPi for Raspberry Pi based platforms.`

			`The Hobbytronics TFT Display, which is a Pi-Hat, connects to the UART on the Raspbery Pi.`

			`The OLED display needs a extra library see OLED.md`
Added manual for oled driver installation 2016-05-10 16:04:50 +00:00
Update README.md in main directory to include LCDproc can't believe I missed this one out when I wrote it! 2017-07-02 16:43:38 +00:00			`The LCDproc support enables the use of a multitude of other LCD screens. See the [supported devices](http://lcdproc.omnipotent.net/hardware.php3) page on the LCDproc website for more info.`

Update the README including the no commercial use section. 2016-01-25 22:34:41 +00:00			`This software is licenced under the GPL v2 and is intended for amateur and educational use only. Use of this software for commercial purposes is strictly forbidden.`