Marcin: Created page with "Device Dashboard Name Clearly state the hardware's name, avoid confusion with other similar projects and infrigements of trademarks. Description Textual description of the ha..."

2013-03-28T03:06:31Z

Created page with "Device Dashboard Name Clearly state the hardware's name, avoid confusion with other similar projects and infrigements of trademarks. Description Textual description of the ha..."

New page

Device Dashboard
Name Clearly state the hardware's name, avoid confusion with other similar projects and infrigements of trademarks.
Description Textual description of the hardware. Include link to Google Translate.
Hardware Version "State the hardware's version in a highly visible place.
Optional: indicate date of release.
Ex: V4 - Dec 18, 2012"
Software Version "State the software's version in a highly visible place.
Optional: indicate date of release.
Ex: V4 - Dec 18, 2012"
Hardware License "State the hardware's open source license and link to license page.
Ex: CC BY-SA"
Software License "State the software's open source license and link to license page.
Ex: GPL"
Attribution Identify the authors and contributors. Identify Active Team Members. Optional: state how you'd like the authors to be credited.
Open Source Label "Graphic indicating which layers of the design are open source. Place in very prominant area (eg. product's home page).
Ex: Electronics: open; Mechanics: closed; Software: closed; Hydraulics: open.; Materials: closed (ex., for special steel alloy)"
Graphical Representation Provide hi-res images of the hardware, preferably allowing zooming and 3D rotation. Use a real picture or a computer model.
Status Brief "State the level of completion of the Hardware, active problem that is currently being solved, and future development intentions. Describe known issues. Burndown graph would be useful.
Ex: Hardware: complete; Software: complete; Documentation: incomplete; Enterprise: product shipping, open business model. Next steps: robustness improvements to allow for 100 hours of unattended operation."
Change Log List of changes/upgrades since last version of the design.
Specifications "List the hardware's specifications.
Ex: http://www.ladyada.net/make/tvbgone/"
Compatibility "State what other peices of hardware the design is compatible with.
Ex: Arduino Leonardo"
Dependency "State what other types of hardware or software are necessary to use the hardware during normal operation, during building, during assembly, during testing, and during de-assembly.
Ex: 5V Power Supply, Ethernet Shield"
Geneology Provide information on the hardware's origins, derivatives and replications. Copy this from the previous version and include your new version.
Human Factors & Usability Overview State general considerations for user-friendliness and performance, such as: (1), whether a machine is 'turnkey,' or whether one has to make numerous adjustments prior to use. Time/procedure required prior to turn-on. (2) Comfort and extras - ex. a cushioned driver's seat that is indispensible for long-time use; lights for night-time use; air-tight cab for a car in cold winter, etc. (3) Unattended operation vs. necessity to watch the machine or make constant adjustements; (4) Quality of result obtained - while Specifications (above) provide quantitative assessment, a quick overview of qualitative performance is useful to assess value of replicating the machine, such as: rough edges are left after a cut with the machine; 'the machine is unbearably so', or 'the machine works equivalent to or better than any commercial counterpart based on speed and quality of resulting product.'
Related Projects "List related projects. If done properly, this has the potential to spawn collaboration between similar projects.
Ex: Local Motors, Wikispeed for OS Car project."
Related Resources List related resources such as other tutorials, similar projects, wikipedia pages, etc.
Tags "List tags that best decsribe the device/design. Make sure to include OSHW.
Ex: OSHW-Shield-Arduino-Electronics."
Replication Map Show locations of all machines in use to keep track of the evolution of the project.
Communication Channels List media of communication, such as Website, Blogs, Wikis, Databases, Support Platform, Google Groups, Facebook Groups, Twitter feed, hashtag, forums, Stack Overflow, email addresses, chats, texting, phone numbers, and other venues of development. Optionally, include notes on how to communicate effectively.
Explainer Video Produce a scripted animation or video showing how the artifact works, why it is important, and otherwise motivate users to engage with the artifact. Show context for how this artifact fits with a greater ecosystem of OSHW. Make this video 2 minutes or under.
Repository Link to repositories of project files. (git, hg, etc.)
Build Dashboard
Difficulty Level "State the difficulty level for building the device.
Ex: Intro Level, Intermediate, Advanced"
Time Required "State the approximate time required to build the device.
Ex: 2 days."
Tools Required "List the tools needed to build the device.
Ex: laser cutter, welder, soldering iron."
Space Required "Indicate the space required to build the device.
Ex: 1000 sf workshop"
Skills Required "Indicate what skills are required to build the device.
Ex: welding, laser cutting."
Cost Include a budget for the project and state the total cost of materials and components.
Safety & Health Warnings on any dangers or risks associated with the build of the artifact - such as risk of injury from moving parts, heavy objects, potential accidents, chemical dangers, fumes, etc..
Ergonomics State the expected time for the build of the artifact. Provide suggestions on effective build process to minimize effort and maximize comfort of the builder. Do this analysis for different production routes used - such as by hand vs. by utilizing automation.

Materials & Components
Bill of Materials (BOM) "BOM's and all parts lists should include unique identifiers: item name*, item description*, quantity*, dimensions/package*, suppliers* part number, link to datasheet, image, price, notes. (*required fields)

Provide information on alternative materials and components whenever possible. Ex: if carbon fiber is not available use punched aluminum. Prefer listing hardware project names based on their semantic versioning name so that they can be automatically found and re-used by software."

Designs
Conceptual Design Conceptual design is the type of design that describes general working principles and outlines main components of an artifact, without necessarily providing dimensionally-correct design of the artifact. Show all the critical parts.
Conceptual Interface Design Show a diagram of an interface prior to that interface being built.
Labeled Diagram This is the actual labeled design - a step above the Concept Design. The labeled diagram may be a CAD or real picture, and it should include different angles. Diagram should label components.
Digital Fabrication Files "Provide digital fabrication files for download in at least one but preferably more standard formats.

Provide previews of digital fabrication files."
Module Diagram Shows the breakdown of the Artifact into modules. Does not have to show components of modules - as the Labeled Diagram already contains this.
Exploded View Drawing http://en.wikipedia.org/wiki/Exploded_view_drawing . Use 3D or isometric drawings as appropriate.
3D CAD Provide 3D CAD of the object, and applies to all 3-dimensional artifacts. Use a commonly accessible platform such as Sketchup in preference to less accessible, proprietary software. Include tolerance information, as discussed at http://opensourceecology.org/wiki/Geometric_Dimensioning_and_Tolerancing
3D preview Provide a preview of all parts in 3D.
3D Scan If CAD is not available, provide a 3D scan of an artifact.
Engineering Drawings Engineering drawings are technical drawings used to fully describe the requirements of engineered items. For machines, this is fabrication drawings.
Fabrication Drawings A special type of engineering drawing used for mechanical devices.
2D Preview Embed the complete design files for a preview of the design.
Wiring, Cable Routing, Hose Routing Diagram Layout of flexible or stiff conduits of all sorts (wires, hoses, airlines, etc) should be provided.
Electronics "Provide hi-res electronics schematics (symbolic representation of the circuit, showing how to connect the components).

Provide PCB layout (concrete representation of the circuit, used to fabricate PCBs).

Provide preview of schematics.

Ex: http://arduino.cc/en/Main/arduinoBoardDuemilanove"
Process Design Produce a design of a process, such as chemical processing. Include all steps, retention times, substances used, etc. Document toolchain in a flowchart.
Hydraulics & Pneumatics Provide a diagram of hydraulic design. Use standard hydraulic symbols, as in http://opensourceecology.org/wiki/Hydraulic_Circuit_Design
Electromagnetic Diagram Provide field lines involved in magnetic devices.
Optical Diagrams Provide optical diagrams - such as ray tracing or focal lengths - for optical systems.
Design Rationale Explanation of why certain design decisions were made for the artifact. Document why you chose one design over another, with reference to Analysis of Industry Standards
Calculations Calculations are required to understand the performance of a machine. These could be power, thermal, force, stress, hydraulics, flow, speed, structural, electromagnetic, or other calculations. This includes Computer Aided Engineering (CAE) analysis such as Finite Element Analysis (FEA). Document any derived quantities. Document online calculator/design resources.
Physics of Why It Works Explanation of first principles involved in the functioning of the machine.
Logic Design Document operating step sequencing and any other logic model required for the operation of the artifact.
Animated Model Animation showing functional mechanism.
Design Review Document reviews of a design. Design review can be general or specific.
Failure Modes and Effects Analysis Analize a design prior to the build for possible failures and document this analysis, including solutions.
3D Diffs Show the difference between versions of the artifact in 3D representation.
Software
Source Code Provide annotated source code, including code logic. Ex., describe brick pressing logic based on physical structure and function of CEB machine.
Firmware Provide firmware.
Instructions Provide instructions for running, installing, compiling, etc.
Libraries Provide any libraries or links to libraries that are needed

Build Instructions
Infrastructure Requirements List the space, power, tooling, timing, environment, and other requirements for the build to occur.
Tool List List tools used in production of Artifact.
Jig Design Show designs of any jigs used in production, and document procedures for using these jigs.
Machine Settings Describe fabrication/production procedures, including suggested machine settings (ex: laser cutter settings, mixing time for cement mixer)
Assembly "Provide set-by-step instructions on how to assemble the Product (from raw materials, parts and/or modules) using either:
- Clear, hi-res images accompanied by clear textual instructions (include link to Google Translate).
- IKEA-style visual instructions"
Assembly Video Produce a video of artifact assembly and disassembly.
Procedure "Provide step-by-step sequence of instructions on how to make Products. This could be a process (for materials), fabrication procedure (for components), procedure (for building) using:
- Clear, hi-res images accompanied by clear textual instructions (include link to Google Translate).- IKEA-style visual instructions - others."
Instructional Video Provide step-by-step video documentation.
Quality Control Procedure for testing the artifact build throughout the fabrication process. Define, execute, and document this procedure.
Integration Checklist List cosiderations that have to be taken when putting all modules together.
Testing
Rapid Prototyping Make scale models of artifacts with a laser cutter and 3D printer to test out parts fit and other issues. Document the build instructions and results of prototype builds.
Test Design Design and document a testing procedure and protocol for a finished design.
Data Collection Collect performance data on the artifact. Discuss how the data was obtained.
Safety Issues Make careful observations about any safety concerns of using the artifact, and document these.
Known Bugs Make an exhaustive list of any known issues about the artifact.
Destructive Testing Test the artifact to its failure limit and gather performance data until that point. Discuss the point of failure.
Product Certification Provide official test data and certification from professional standards associations.
User Manual
Operation Startup, operating, calibration instructions.
Safety Safety instructions.
Maintenance Describe standard procedures for maintenance over time.
Troubleshooting Discuss common failure modes and state how these can be identified and fixed.
Repair Document common problems and procedures for fixing them.
Product Hacking Document how to modify artifact or how to use it with other modules. Provide insights on user experience.
Specific Use Cases Document techniques of how to apply the artifact to specific tasks. Ex., discuss the procedure for using the torch table to cut a brick press out of metal sheet.
Build Techniques Provide tutorials on fabrication processes required to build, repair, or modify the artifact, in more detail than in the fabrication process.
Sourcing Document part sources, availability, cost.

Enterprise
Economic Analysis Evaluate production cost, including facility, consumables, materials, labor. Calcultate return on investment.
Ergonomic Analysis Assess time of production, facility design as it relates to fabrication efficiency, human fatigue, productivity levels. Document any details related to human comfort and cognitive capacity- related to the production process..
Workshop Layout Draw a diagram of suggested workshop layout.
Fabrication Ergonomics Ergonomic analysis specifically on the time of production. Document the time it takes for every production step.
Tooling Cost List tools used and sum up their cost.
Supply Chain Map all suppliers worldwide, both commercial and private. Map natural resources that can be used to produce supplies.
Production Optimization Analysis and suggestions on how additional efficiencies can be gained in a production process. Document known ways to achieve this. Possible routes could be parallelization, proper sequencing, automation, or others.
Store for Purchasing Artifact Provide a venue for sellig the artifact.
Product Stickers Provide a means for a person to acquire product stickers.
Internal Certification Provide procedure for approving product for inernal standards.
Producer License Define license by which others can sell the artifact.
Producer Training Provide a program to train interested producers.
Related Enterprises Document enterprises that can be carried out with an artifact, such as a construction business for the brick press.
Appendix
Presentation Slides Create presentation matarial for community use so that people can discuss the project effectively.
Links Useful links on the history, wikipedia article on the topic, others.
Related Patents Industry patents are one way to research possible design concepts. List patents and summarize briefly what one can learn from a given patent.
Interface Design Specifiy interface between modules. Specify interface between components of modules. Specify match geometry. Use standard connector specifications for electronics, hydraulics, and pneumatics and reference these. For non-standard interfaces, include a technical drawing with dimensions and other specifications.
Analysis of Industry Standards List producers, and list the mechanisms of operation of leading competitors. Suggested: include performance specifications and cost.
Consumables List the materials that are used up when artifact is produced, such as welding wire, disposable parts.
Product Ecology Describe how the artifact fits within the greater ecosystem of open source goods.
Video Repository Upload videos of the machine design, build, testing, and other aspects. Post your content on a video sharing site, and index the footage with a comment on the video sharing site.
3D Scan Provide a 3D scan of an
Augmented Reality Instructional Produce label overlays on components or modules to provide augmention for identifying parts and for carrying out fabrication procedures.
High Resolution Media Upload high resolution images that can be used for PR purposes
News Newsfeed on the project.

Sample Infomous Cloud - Revision history

Marcin: Created page with "Device Dashboard Name Clearly state the hardware's name, avoid confusion with other similar projects and infrigements of trademarks. Description Textual description of the ha..."