Redzed

Welcome to Redzed’s documentation. The intended audience are Python developers. Redzed is an asyncio-based Python library for building automated systems.

Please excuse language mistakes in this documentation. The author is not a native English speaker.

Index

• Index

Table of contents

Introduction

• Welcome to Redzed
  • What it can do?
  • Example programs
• Installation
  • Prerequisites
  • Installing

Circuit basics

• Blocks, Triggers, Formulas
  • Three types of circuit components
  • Logic blocks
  • Triggers
  • Formulas
  • Function parameters in Triggers and Formulas
• Events
  • Event sources and destinations
  • Event type and data
  • Monitoring events
  • Examples (events)
• Block Initializers
  • Initialization process
  • Initializers

Included logic blocks

• Data validation
  • ValidationError
• Circuit inputs
  • Pushing data into the circuit
  • Polling data sources
• Circuit outputs
  • Stop functions
  • Output data validation
  • Sync outputs
  • Async outputs
• Finite-State Machines
  • FSM introduction
  • Creating FSM types
  • FSM examples
  • Creating FSM blocks
  • FSM Initialization rules
• Time and date intervals
  • Specifying intervals
  • Periodic events
  • Non-periodic events
  • Dynamic updates
  • Cron service
• Auxiliary blocks
  • Counter
  • Repeat
  • Timer

Running a circuit

• Circuit runner
  • Pre-start checklist
  • Running a circuit
  • Stopping the circuit
  • Supporting tasks
• Persistent state
  • Requirements
  • Enabling
• Error handling
  • Reporting and handling of errors
  • Error checking in asyncio
• Circuit examination
  • Finding components
  • Inspecting Formulas and logical Blocks
  • Inspecting Blocks
  • Inspecting the circuit
  • Inspecting the persistent storage
  • Version information
• Logging, debug messages
  • Logger
  • Handlers
  • Debug output
  • Debug levels

API reference

• Block API
  • Block
  • 1. Name and comment
  • 2. Output
  • 3. Circuit membership
  • 4. Setup and start
  • 5. Persistent state
  • 6. Shutdown and cleanup
  • 7. Event handling
  • 8. Logging functions
  • 9. Application data
• Circuit API
  • get_circuit()
  • redzed.reset_circuit()
  • CircuitState
  • Circuit
  • 1. Circuit components
  • 2. Circuit state
  • 3. Persistent storage
  • 4. The runner
• Formula API
  • Formula.get()
  • Formula.is_initialized()
  • Formula.circuit
• Cron service API
  • Cron clients
  • Cron server
• Utilities
  • Time durations with units
  • Clock related constants
  • Date/time intervals as strings

About

• License
• Changelog
• About redzed