Skip to content

Commit 131593c

Browse files
committed
Update installation instructions
1 parent 62d769f commit 131593c

File tree

2 files changed

+27
-8
lines changed

2 files changed

+27
-8
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,34 @@ Currently supports:
1313

1414
Loosely based on `dmcomm-python`, but avoiding dynamic allocation (except in SerialFollower).
1515

16-
## Installing library
17-
* Clone the repo into your [Arduino libraries directory](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#manual-installation)
18-
* OR Use the "Download ZIP" option on GitHub with `Sketch > Include Library > Add .ZIP Library`
19-
* If updating, you will need to delete the previous version first
20-
* Open the ClassicComUnit example
16+
## Board Types
17+
18+
* Almost any premade A-Com will be a Nano. Some have the "old bootloader" which requires a different flashing option.
19+
* Bazjo D-Com v2 (bought since Dec 2023) works as a Nano.
20+
* Bazjo D-Com v1 uses ATmega328PB and requires special flashing options.
21+
22+
## Installation Tools
23+
24+
[ACom Flasher](https://play.google.com/store/apps/details?id=com.mintmaker.acomflasher&hl=en&gl=US)
25+
* OS support: Android
26+
* Board support: Uno, Nano, Bazjo D-Com v1
2127

22-
## Hardware setup
28+
[Alpha Upload](https://github.com/Alpha-Dev-Project/alpha-upload/releases/)
29+
* OS support: Windows (from the above link); Mac (unofficially, check the 0NL1NE server)
30+
* Board support: Uno, Nano, Leonardo
31+
* Make sure to choose "DMComm Arduino" before flashing!
32+
33+
## Install from Source
34+
35+
### Hardware setup
2336
* Find the [Arduino15 folder](https://support.arduino.cc/hc/en-us/articles/360018448279-Open-the-Arduino15-folder)
2437
* ATmega32U4:
2538
* Increasing the serial buffer is not required
2639
* Nano/Uno:
2740
* From the Arduino15 folder, go to `packages/arduino/hardware/avr/{version}`
2841
* Create `platform.local.txt` containing `compiler.cpp.extra_flags=-DSERIAL_RX_BUFFER_SIZE=128`
2942
* Restart the Arduino IDE
30-
* Bazjo D-Com:
43+
* Bazjo D-Com v1:
3144
* Install [MiniCore](https://github.com/MCUdude/MiniCore#how-to-install)
3245
* From the Arduino15 folder, go to `packages/minicore/hardware/avr/{version}`
3346
* Open `boards.txt`
@@ -37,6 +50,12 @@ Loosely based on `dmcomm-python`, but avoiding dynamic allocation (except in Ser
3750
* Restart the Arduino IDE
3851
* From the Tools menu, select `Board:MiniCore:ATmega328` and `Variant:328PB` (leave the other board options alone)
3952

53+
### Installing library
54+
* Clone the repo into your [Arduino libraries directory](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#manual-installation)
55+
* OR Use the "Download ZIP" option on GitHub with `Sketch > Include Library > Add .ZIP Library`
56+
* If updating, you will need to delete the previous version first
57+
* Open the ClassicComUnit example
58+
4059
## Other DMComm versions
4160
* For the original version which is not a library, see https://github.com/dmcomm/dmcomm-project
4261
* For the CircuitPython version for RP2040, see https://github.com/dmcomm/dmcomm-python

src/dmcomm_build_info.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
// This file is intended to be overwritten by the build CI.
44
// Does not have its own include guards, should be checked by includer.
55

6-
#define DMCOMM_BUILD_INFO F("name = \"dmcomm-arduino-lib\"\r\nversion = \"v0.4.1\"")
6+
#define DMCOMM_BUILD_INFO F("name = \"dmcomm-arduino-lib\"\r\nversion = \"v0.4.1+wip\"")

0 commit comments

Comments
 (0)