Skip to content

Latest commit

 

History

History
175 lines (119 loc) · 8.17 KB

README.md

File metadata and controls

175 lines (119 loc) · 8.17 KB
Raw


KOUDOU

KOUDOU Flow supports your flow-based planning and action for crisis response with Node-RED backend


Features • Getting Started • Self-hosting • Project Details • Roadmap • Resources • Authors

Updates

Features

  • Block-based planning made easy for every role in crisis response
  • Extendable and customizable using integrated Node-RED/Watson IoT Platform
  • Built-in Web-based mobile app and speaker interface for quickstart
  • Offline aware: PDF export (experimental), Save as JSON to run locally

Getting Started

Demo video

Demo instance

NOTE:

  • Running on a personal IBM Cloud account; please contact the team if the instance is down.
  • Functionalities may have monthly caps and rate limits. (e.g. Text to Speech)

Example Case 1: Simlulate your own plan

  1. Log in as demo1@example.com
  2. Select "Response Plan for Earthquake (demo)"
  3. Scan the QR code or click link to open your mobile app
  4. (Optional) Set up a speaker interface
  5. Return to the plan page and click "Simulate This Plan"
  6. Click "Next Phase"
  7. Click "Complete"

Example Case 2: Create a new plan

  1. Log in as demo1@example.com
  2. Click "Prepare a new plan" at the top
  3. Select "Earthquakes"
  4. Enter the Plan Description
  5. Drag & Drop Step Blocks to the flow to make a plan
  6. Save

Example Case 3: Demonstrate a crisis response operation

  1. Open mobile app as demo1@example.com on your smartphone (follow example case 1)
  2. On your laptop, log in as demo2@example.com by checking "Log in as operator" box
  3. Select "Control" from right menu
  4. Toggle "Issue New Alert"
  5. Select "Feed" from right menu
  6. Follow instructions on the mobile app
  7. Check the feed and other operations

Self-hosting

Use a separate Node-RED instance

  • Set the environment variable NODEREDBASE to your Node-RED base URL to use a separate Node-RED instance. (Default: http://localhost:9000)

Common

  • Set the environment variable DEMO to 1 in manifest.yml or elsewhere to set up the instance as a demo.
  • Set a secret operatorToken in config/default.json for operator login.
  • Add API keys to related Node-RED nodes to enable Watson AI and other IBM Cloud services (e.g., Watson Text to Speech for speakers)
  • Import Node-RED flows for KOUDOU:
    • Copy the output of node nodered-lib/splitter.js --join
    • Import it to your Node-RED instance

Local (stand-alone, with Docker)

$ docker-compose build --build-arg DEMO=1
$ docker-compose up  # Startup http://localhost:3030/

$ docker-compose down  # Shutdown

IBM Cloud (stand-alone)

Prerequisite:

$ ibmcloud cf push

IBM Cloud (advanced, with Watson IoT Platform/Node-RED Starter)

Prerequisites:

  • Set up ibmcloud CLI with your IBM Cloud account
  • Set up Watson IoT Platform/Node-RED Starter from the IBM Cloud catalog
    • Set NODEREDBASE to the base URL of your Node-RED instance
    • (Optional) Set noderedAPIPath to the base path for APIs exposed by Node-RED (Default on IBM Cloud Starter: /)
  • Set the environment variable SYSTEM_URL of your Node-RED instance to the host of your KOUDOU instance.
$ ibmcloud cf push

"Deploy to IBM Cloud" buttons are in preparation.

Project Details

Description

KOUDOU flow supports your flow-based planning and actions in disaster situations. Management organizations and people easily get into panic when the disaster happens in sudden.According to the statistical survey and our interviews to the university students and management office, most of them are feeling a sense of crisis about the disaster, but few of them actually take actions for preparing and updating an action manual. Some organizations and people have already had some action manuals including Business Continuity Plan (BCP): however, persons in charge of our university are anxious in practical use. They understand the necessity of the action manual, but there are many things to take into consideration such as the type of disaster, the period of time, the partnership with other organizations and locals, and so forth. Therefore, the creation and update of action manual are costly and troublesome. Moreover, the action manual formulated by others cannot refer as it is because each organization and people have peculiar situations.

Based on the real opinions and situation, we propose a code that supports your flow-based planning and action before, during, and after the disaster situations with agile development. Our main targets are university students and management office.

KOUDOU flow provides functions to support the flow-based planning and actions in addition to the mapping and the status management of students and items. Users can easily and freely set action blocks to each disaster. Some action templates are available: therefore, the users easily start preparing and updating the action manual. For the university office, they have already had BCP, but they are not well digitalized and might be confused in the disaster situations. Moreover, they would like to collect information such as the damage of buildings, the safety and location of students and staffs, and the available stockpiles and expected demands as soon as possible for taking the next appropriate action. The more university office collects information, the more they can take better actions. As one example, they may request the safety confirmation block to the student users. For the student users, they can design the action flow by respecting the action manual published by the university as well as the blocks for personal action such as bringing the medicine and ID. The progress of action flow is visualized so that the users easily grasp the current situation and what they should do next. Since warnings from government like Earthquake Early Warning (EEW) are the trigger of launching KOUDOU flow, the users will never forget to follow the action manual formulated by the university and individual. The disasters will occur someday for sure, and it is crucial to enhance our awareness of disaster prevention on a regular basis. Therefore, KOUDOU flow provides the training mode as well.

The main plans from hereon are 1. Further Development of user interface and APIs, 2. Integration with IoT devices, and 3. Proof of concept at our university by collaborating with ICT center.

Let’s streamlining your actions by using KOUDOU flow!!

Powered by/works with IBM Cloud services including:

Roadmap

Resources

Authors

  • Toshiaki Okano
  • Kentaro Ozeki
  • Takeshi Sano
  • Takaomi Takahashi