Welcome to Amast

Welcome to Amast’s documentation. Amast is a lightweight C application toolkit. It is designed to make getting started quick and easy, with the ability to scale up to complex applications.

Get started with Installation and then get an overview with the Quickstart. There is also a more detailed Tutorial that shows how to create a small but complete application with Amast. Common patterns are described in the Patterns section. The rest of the docs describe each component of Amast in detail, with a full reference in the API section.

User’s Guide

Amast provides configuration and conventions, with sensible defaults, to get started. This section of the documentation explains the different parts of the Amast toolkit and how they can be used, customized, and extended.

• Installation
• Quickstart
• Tutorial
• Patterns
• Hierarchical State Machine (HSM)
  • Credit
  • Glossary
  • Introduction
  • Example HSM
  • State Relations
  • Event Propagation
  • State Transition
  • Initial State Transition
  • Initial State
  • HSM Initialization
  • HSM Topology
  • HSM Coding Rules
  • Transition To History
  • Submachines
• Finite State Machine (FSM)
  • Glossary
  • Introduction
  • Example FSM
  • Event Handling
  • State Transition
  • Initial State
  • FSM Coding Rules
  • FSM Initialization
  • Transition To History
• Active Object (AO)
  • Overview
  • Key Features
  • Usage Scenarios
  • Design Considerations
  • Module Configuration
  • System Integration
  • Limitations
• Event
  • Overview
  • Key Features
  • Usage Scenarios
  • Design Considerations
  • Module Configuration
  • System Integration
• Async-Await
  • Overview
  • Async Macros and Functions
  • Usage Example
  • Notes
• Timer
  • Overview
  • Key Features
  • Usage Scenarios
  • Design Considerations
  • Module Configuration
  • System Integration
• Onesize Memory Allocator
  • Overview
  • Key Features
  • Usage Scenarios
  • Design Considerations
  • Module Configuration
  • System Integration
  • Limitations
• Ring Buffer
  • Overview
  • Key Features
  • Usage Scenarios
  • Design Considerations
  • Module Configuration
  • System Integration
  • Limitations

API Reference

If you are looking for information on a specific function, structure or define, this part of the documentation is for you.

• API
  • Common Constants
  • Common Types
  • Singly Linked List
  • Bit
  • Ring Buffer
  • Queue
  • Onesize
  • Event
  • Timer
  • Async
  • HSM
  • FSM
  • AO
  • PAL

Additional Notes

• Design
• Contributing
• License
• Changes