Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to FSM and Pipeline abstractions and documentation #414

Merged
merged 7 commits into from
Sep 20, 2023

Conversation

mkorbel1
Copy link
Contributor

Description & Motivation

  • Renamed StateMachine to FiniteStateMachine (deprecated StateMachine name)
  • Expose mapping from StateIdentifier to state index in FiniteStateMachine
  • Deprecated clk on Pipeline and FiniteStateMachine abstractions
  • Allow FiniteStateMachine states to use "priority" (and "none") instead of only "unique".
  • Add support for multi-trigger support for the Sequentials in FiniteStateMachine and Pipeline abstractions
  • Refactor the "traffic light FSM" to use newer features from Dart and FiniteStateMachine to be more readable as a helpful example
  • Update the FSM documentation in the user guide to be more helpful

Related Issue(s)

Fix #409
Fix #372
Fix #406
Fix #400

Testing

Modified some tests to cover functionality added

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

Some deprecations, but no backwards compatibility breaking changes

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Updated some docs and API docs

@mkorbel1 mkorbel1 changed the title Fsm updates Updates to FSM and Pipeline abstractions and documentation Sep 19, 2023
@mkorbel1 mkorbel1 merged commit f1c647a into intel:main Sep 20, 2023
1 of 2 checks passed
@mkorbel1 mkorbel1 deleted the fsm_updates branch September 20, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant