diff --git a/README.md b/README.md index e498d80..bf4383b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,15 @@ Arduino library to make ammo counters and more for highly modified NERF blasters. -#### Features Included: +___ + +## Contents: +- [Features Included](#features-included) +- [Hardware, Parts, and Tools Needed](#hardware,-parts,-and-tools-needed) +- [Installation](#installation) + + +## Features Included: 1. **Ammo Counting:** Count your ammo. Whenever you fire a dart, it's detected using one of these methods: 1. **Switch**: Detect shots every time the trigger is pressed. Orient a tactile switch to be pressed when the blaster's trigger is pressed, and wire it up to the microcontroller. May not be ideal for fully-automatic blasters. 2. **Infrared (IR) Gate**: Using both an IR transmitter diode and IR receiver diode to detect dart passage rather than physical trigger pulls. The transmitter and receiver should be positioned so the transmitter shines directly on the receiver along the diameter of the barrel, forming a "gate". When a dart is fired, the gate is broken, which is detected with the microcontroller. @@ -14,10 +22,10 @@ Arduino library to make ammo counters and more for highly modified NERF blasters 7. **Count-Up Mode**: Instead of counting down, it can count up every time a shot is fired. ___ -### Hardware, Parts, and Tools Needed +## Hardware, Parts, and Tools Needed All builds require some sort of Arduino-compatible microcontroller. I recommend the [Adafruit Pro Trinket](https://www.adafruit.com/product/2000). Also make sure to have the [Arduino IDE](https://www.arduino.cc/en/Main/Software) installed. -#### Parts: +### Parts: |Features vs Parts Required | Ammo Counter - Switch | Ammo Counter - IR Gate| Chronograph | Voltmeter| Select - Fire | Usages| Notes | |:--------------------------|:---------------------:|:---------------------:|:-----------:| :-------:|:-------------:|:-----:|:-----:| | Microcontroller | X | X | X | X | X | Brains of everything. | Microcontroller recommendation above | @@ -29,7 +37,7 @@ All builds require some sort of Arduino-compatible microcontroller. I recommend | Resistors (10K and 100k) | | | | X | | Used for voltage divider to drop the voltage to a safe level for the microcontroller. | Resistors can be different values, just make sure the battery being checked has its voltage dropped to a voltage safe for the microcontroller. | | [Relay](https://www.amazon.com/Tolako-Arduino-Indicator-Channel-Official/dp/B00VRUAHLE/ref=sr_1_2?ie=UTF8&qid=1498071951&sr=8-2&keywords=arduino+relay)| | | | | X | Used to control the NERF blaster's motors through the microcontroller | -#### Tools: +### Tools: 1. Phillips Head Screwdriver 2. Drill 3. Soldering Iron and Solder + soldering materials/tools (flux, shrink wrap, helping hands, etc.) @@ -43,9 +51,9 @@ All builds require some sort of Arduino-compatible microcontroller. I recommend 2. Microcontroller will need a battery to power it. A 9v will work fine. If the blaster is an electronic blaster, the microcontroller can be powered off the same batttery as the blaster, at the cost of a slight decrease in the blaster's performance. +___ - -### Installation +## Installation `cd ../Arduino/libraries` `git clone https://github.com/etnom/nerf-ammo-counter`