Added readme & license

Author: j54n1n

avr/libraries/AnalogMultiplexer/LICENSE.md

@@ -0,0 +1,23 @@
+Library for the CMOS 40xx analog multiplexer series.
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Julian Sanin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

avr/libraries/AnalogMultiplexer/README.md

@@ -0,0 +1,33 @@
+# CMOS 40xx Analog Multiplexer Series Library
+A library to interface with analog multiplexers. Supports 4051, 4052, 4053, and
+4067 series multiplexers.
+
+## How to use
+```
+#include <AnalogMultiplexer.h>
+
+enum {
+	PIN_EN = 2, // The enable pin of the multiplexer.
+	PIN_S0 = 3, // Channel selector pin 0.
+	PIN_S1 = 4, // Channel selector pin 1.
+	PIN_S2 = 5, // Channel selector pin 2.
+	PIN_IO = A0 // Use here a pin that can work in analog & digital modes.
+};
+
+AMxx4051 mux{ PIN_EN, PIN_S0, PIN_S1, PIN_S2 }; // 8:1 Multiplexer.
+
+void setup() {
+	Serial.begin(9600);
+	while (!Serial);
+}
+
+void loop() {
+	mux.pinMode(PIN_IO, INPUT); // PIN_IO will be used to read from the mux.
+	mux.enable(); // Enable multiplexer.
+	for (int channel = 0; channel < 8; channel++) {
+		int value = mux.analogRead(channel); // Do analog read.
+		Serial.println(value);
+	}
+	Serial.println();
+}
+```

avr/libraries/AnalogMultiplexer/examples/AnalogMultiplexerExample/AnalogMultiplexerExample.ino

@@ -42,7 +42,7 @@ void setup() {
 		Serial.println(value);
 	}
 	Serial.println();
-	mux.disable(); // Switch of multiplexer.
+	mux.disable(); // Switch off multiplexer.
 }
 
 void loop() { }

avr/libraries/AnalogMultiplexer/src/AnalogMultiplexer.cpp

@@ -1,3 +1,29 @@
+/*
+ * Library for the CMOS 40xx analog multiplexer series.
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Julian Sanin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #include "AnalogMultiplexer.h"
 
 AnalogMultiplexer::AnalogMultiplexer(uint8_t pinEnable) {

avr/libraries/AnalogMultiplexer/src/AnalogMultiplexer.h

@@ -1,3 +1,29 @@
+/*
+ * Library for the CMOS 40xx analog multiplexer series.
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Julian Sanin
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #ifndef ANALOG_MULTIPLEXER_H
 #define ANALOG_MULTIPLEXER_H