<commit_before>Bean - A BLE Arduino By Punch Through Design
=============================================

Repo Overview
-------------

This repo contains the Arduino firmware and installation files used in the LightBlue Bean project. The firmware files are based off of the Arduino firmware release version 1.0.5 and have been modified to work on the LightBlue Bean, a system that has on it a few other features, a BLE radio an accelerometer and a multicolor LED.

### Key Files:

#### Everything in the `hardware` directory
The contents of the hardware directory should be copied into the Arduino program resources hardware directory on install.  This directory contains the firmware for the LightBlue Bean, as well as the files needed for the Arduino IDE to recognize the board allow users to program it.

#### Everything in the `examples` directory
The contents of the examples directory should be copied separately on install to the exaples resources in the Arduino IDE.

#### Everything in the `beanModuleEmulator` directory
This directory contains an Emulator of the 'non-Arduino' parts of the bean.  This acts as a test jig for the Arduino code, and allows us to verify that things operate as expected.  You can run `python BeanModuleEmulator.py` from within the beanModuleEmulator directory.

##### Dependencies

There are a few python library dependencies you'll need to make the emulator work:

* TkInter
* numpy
* pyserial
* enum

The emulator has been tested with python 2.7.6 installed by Homebrew on OSX

### Development:
During development, it is recommended to use soft links from inside your Arduino IDE resources to your repository.  It will make it easier to test your work.<commit_msg>Added a TODO to the repo README<commit_after>Bean - A BLE Arduino By Punch Through Design
=============================================

Repo Overview
-------------

This repo contains the Arduino firmware and installation files used in the LightBlue Bean project. The firmware files are based off of the Arduino firmware release version 1.0.5 and have been modified to work on the LightBlue Bean, a system that has on it a few other features, a BLE radio an accelerometer and a multicolor LED.


### TODO:

* Fix Serial.println so, like Serial.print, extra radio messages arn't sent for the newline
* Add proper doxygen comments to relelvent parts, especially the API
* Add features to emulator to provide better, more useful testing
* Add more and better examples
* Modify Serial.begin() to ignore it's input and always set to 57600.
* Possibly add features needed for Arduino power toggling


### Key Files:

#### Everything in the `hardware` directory
The contents of the hardware directory should be copied into the Arduino program resources hardware directory on install.  This directory contains the firmware for the LightBlue Bean, as well as the files needed for the Arduino IDE to recognize the board allow users to program it.

#### Everything in the `examples` directory
The contents of the examples directory should be copied separately on install to the exaples resources in the Arduino IDE.

#### Everything in the `beanModuleEmulator` directory
This directory contains an Emulator of the 'non-Arduino' parts of the bean.  This acts as a test jig for the Arduino code, and allows us to verify that things operate as expected.  You can run `python BeanModuleEmulator.py` from within the beanModuleEmulator directory.

##### Dependencies

There are a few python library dependencies you'll need to make the emulator work:

* TkInter
* numpy
* pyserial
* enum

The emulator has been tested with python 2.7.6 installed by Homebrew on OSX

### Development:
During development, it is recommended to use soft links from inside your Arduino IDE resources to your repository.  It will make it easier to test your work.
{'fraction_non_alphanumeric': 0.07049608355091384, 'fraction_numerical': 0.004438642297650131, 'mean_word_length': 4.488538681948424, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '277843', 'n_tokens_mistral': 956, 'n_tokens_neox': 889, 'n_words': 567}