SchmittTrigger

This is a simple rubygem that implements a Schmitt Trigger

SchmittTrigger's have awesome applications, but I haven't actually come across a need for them in code, so this is purely for fun.

Add this line to your application's Gemfile:

gem 'schmitt-trigger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install schmitt-trigger

To initialize a SchmittTrigger pass in the lower threshold and upper threshold when initializing in that order:

schmitt_trigger = SchmittTrigger.new(-1, 1)
=> #<SchmittTrigger:0x007fd3bc32dda8 @lower_threshold=-1, @upper_threshold=1>

On a cold start it returns the lower_threshold as the output

> schmitt_trigger.run(-5)
=> [-1]
> schmitt_trigger.run(0)
=> [-1]

When the output is at lower threshold it toggles to the upper threshold only after the signal reaches the upper threshold.

schmitt_trigger.output
=> -1
schmitt_trigger.run([-5, 0, 1, 2])
=> [-1, -1, 1, 1]

When the output is at upper threshold it toggles to the lower threshold only after the signal reaches the lower threshold.

> schmitt_trigger.output
=> 1
> schmitt_trigger.output
=> 1
> schmitt_trigger.run([4, 2, 0, -1, -5])
=> [1, 1, 1, -1, -1]

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/schmitt-trigger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.