Merge branch 'master' of https://github.com/kollokollo/ArduinoFloppyDiskReader into kollokollo-master

Author: RobSmithDev

ArduinoFloppyReader/lib/ArduinoInterface.cpp

@@ -46,7 +46,9 @@ using namespace ArduinoFloppyReader;
 #define COMMAND_ENABLEWRITE        '~'
 #define COMMAND_ERASETRACK         'X'
 #define COMMAND_DIAGNOSTICS        '&'
-
+#define COMMAND_SWITCHTO_DD		   'D'
+#define COMMAND_SWITCHTO_HD		   'H'
+#define COMMAND_DETECT_DISK_TYPE   'M'	// currently not implemented here
 
 // Convert the last executed command that had an error to a string
 std::string lastCommandToName(LastCommand cmd) {
@@ -63,6 +65,7 @@ std::string lastCommandToName(LastCommand cmd) {
 	case LastCommand::lcWriteTrack:		return "WriteTrack";
 	case LastCommand::lcRunDiagnostics:	return "RunDiagnostics";
 	case LastCommand::lcEraseTrack:		return "EraseTrack";
+	case LastCommand::lcSwitchDiskMode: return "SetCapacity";
 	default:							return "Unknown";
 	}
 }
@@ -438,6 +441,18 @@ DiagnosticResponse ArduinoInterface::enableReading(const bool enable, const bool
 	}
 }
 
+// Check and switch to HD disk
+DiagnosticResponse ArduinoInterface::setDiskCapacity(bool switchToHD_Disk) {
+	// Disable the device
+	m_lastError = runCommand(switchToHD_Disk ? COMMAND_SWITCHTO_HD : COMMAND_SWITCHTO_DD);
+	if (m_lastError != DiagnosticResponse::drOK) {
+		m_lastCommand = LastCommand::lcSwitchDiskMode;
+		return m_lastError;
+	}
+
+	return m_lastError;
+}
+
 // Select the track, this makes the motor seek to this position
 DiagnosticResponse ArduinoInterface::selectTrack(const unsigned char trackIndex) {
 	if (trackIndex > 81) {

ArduinoFloppyReader/lib/ArduinoInterface.h

@@ -108,7 +108,8 @@ namespace ArduinoFloppyReader {
 		lcReadTrack,
 		lcWriteTrack,
 		lcEraseTrack,
-		lcRunDiagnostics
+		lcRunDiagnostics,
+		lcSwitchDiskMode
 	};
 
 	class ArduinoInterface {
@@ -165,6 +166,9 @@ namespace ArduinoFloppyReader {
 		// Check CTS status by asking the device to set it and then checking what happened
 		DiagnosticResponse testDataPulse();
 
+		// Check and switch to HD disk
+		DiagnosticResponse setDiskCapacity(bool switchToHD_Disk);
+
 		// Select the track, this makes the motor seek to this position
 		DiagnosticResponse  selectTrack(const unsigned char trackIndex);
 

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+Guide to contributing to the Arduino Floppy Disk Controller
+===========================================================
+This document was provided by kollokollo
+
+The Arduino firmware is already very useful und can read everything.
+The track is always read at-once, because the sector-wise reading depends
+on the format (AMIGA, PC, ATARI, COMMODORE etc..). Letting the format be 
+detected by PC software is part of the concept, and sufficiently smart, 
+so this need not be changed. To read a single sector, the PC software can 
+instruct the Arduino formware to read the whole track, and then it can 
+decode only a single sector. There are options to wait or not wait for the 
+index pulse when reading, so that even a fast reading should be possible.
+
+Improvements can be done with writing to the disk. Here contributions are 
+welcome.
+
+However writing is olnly supported for DD track-at once currently. Since the 
+Arduino cannot buffer the data for a whole track, the writing need do be 
+in sync with data arriving via the serial interface. This is a bit tricky 
+and does not always work. Writing a track at once is the normal way to either
+* format the disk (ATARI ST, PC) or
+* write data to it (AMIGA).
+Writing individual Sectors should maybe made possible in furture (and a single 
+sector data can well be buffered by the firmware). But sector detection is 
+format dependant. Luckily for the ATARI ST and PC disks the sector marks 
+are the same. COMMODORE disks will maybe later be supported. 
+
+
+Other ideas: 
+* How about a block device driver for linux (interfacinge the Arduino firmware)?
+
+## License and attribution
+
+All contributions must be properly licensed and attributed. If you are contributing your own original work, then you are offering it under a CC-BY license (Creative Commons Attribution). If it is code, you are offering it under the GPL-v2. You are responsible for adding your own name or pseudonym in the Acknowledgments file, as attribution for your contribution.
+
+If you are sourcing a contribution from somewhere else, it must carry a compatible license. The project was initially released under the GNU public licence GPL-v2 which means that contributions must be licensed under open licenses such as MIT, CC0, CC-BY, etc. You need to indicate the original source and original license, by including a comment above your contribution. 
+
+## Contributing with a Pull Request
+
+The best way to contribute to this project is by making a pull request:
+
+1. Login with your Github account or create one now
+2. [Fork](https://github.com/kollokollo/ArduinoFloppyDiskReader#fork-destination-box) the ArduinoFloppyDiskReader repository. Work on your fork.
+3. Create a new branch on which to make your change, e.g.
+`git checkout -b my_code_contribution`, or make the change on the `new` branch.
+4. Edit the file where you want to make a change or create a new file in the `contrib` directory if you're not sure where your contribution might fit.
+5. Edit `ACKNOWLEGEMENTS` and add your own name to the list of contributors under the section with the current year. Use your name, or a github ID, or a pseudonym.
+6. Commit your change. Include a commit message describing the correction.
+7. Submit a pull request against the ArduinoFloppyDiskReader repository.
+
+
+## Contributing with an Issue
+
+If you find a mistake and you're not sure how to fix it, or you don't know how to do a pull request, then you can file an Issue. Filing an Issue will help us see the problem and fix it.
+
+Create a [new Issue](https://github.com/kollokollo/ArduinoFloppyDiskReader/issues/new) now!
+
+
+## Thanks
+
+We are very grateful for your support. With your help, this implementation will be a great project.