Permalink
Browse files

general reorganization of project-related files; project file referen…

…ce material
  • Loading branch information...
yesnoio committed May 15, 2017
1 parent 7b5ce5d commit 1b526b15a0a136258096d4839338c567017d2da7
Showing with 326 additions and 125 deletions.
  1. +9 −1 README.md
  2. +2 −2 connectors/module-tiny/rj11/rj11.yaml
  3. +1 −1 definitions/dmx.yaml
  4. +11 −0 definitions/one-wire.yaml
  5. +13 −0 modules/README.md
  6. +0 −6 modules/client/README.md
  7. +0 −16 modules/client/clothing-accessories/README.md
  8. +0 −4 modules/client/clothing-costume-props/hair-pigtails-fiber-optic/hair-pigtails-fiber-optic.yaml
  9. +1 −1 modules/client/robotics/README.md
  10. +0 −8 modules/client/robotics/ear-dog-cat/ear-dog-cat.yaml
  11. +0 −6 modules/host/README.md
  12. +4 −0 projects/README.md
  13. +0 −1 {modules/client → projects}/clothing-accessories/backpack/backpack.yaml
  14. +0 −1 {modules/client → projects}/clothing-accessories/badge/badge.yaml
  15. +0 −1 {modules/client/clothing-costume-props → projects/clothing-accessories}/belt-glow/belt-glow.yaml
  16. +0 −1 {modules/client/clothing → projects/clothing-accessories}/belt/belt.yaml
  17. +0 −1 {modules/client → projects}/clothing-accessories/clutch/clutch.yaml
  18. +0 −1 {modules/client → projects}/clothing-accessories/necklace/necklace.yaml
  19. +0 −1 {modules/client → projects}/clothing-accessories/purse/purse.yaml
  20. +17 −0 {modules/client → projects}/clothing/README.md
  21. +0 −1 {modules/client → projects}/clothing/dress/dress.yaml
  22. +0 −1 {modules/client → projects}/clothing/hoodie/hoodie.yaml
  23. +0 −1 {modules/client → projects}/clothing/jacket/jacket.yaml
  24. +0 −1 {modules/client/clothing-accessories → projects/clothing}/leg-warmers/leg-warmers.yaml
  25. +1 −2 {modules/client → projects}/clothing/pants/pants.yaml
  26. +0 −1 {modules/client → projects}/clothing/shirt/shirt.yaml
  27. +0 −1 {modules/client → projects}/clothing/shoe-boot/shoe-boot.yaml
  28. +0 −1 {modules/client → projects}/clothing/shoe-heel/shoe-heel.yaml
  29. +0 −1 {modules/client → projects}/clothing/shoe-sandal/shoe-sandal.yaml
  30. +0 −1 {modules/client → projects}/clothing/shoe/shoe.yaml
  31. +0 −1 {modules/client → projects}/clothing/shorts/shorts.yaml
  32. +0 −1 {modules/client → projects}/clothing/skirt/skirt.yaml
  33. +0 −1 {modules/client/clothing-accessories → projects/clothing}/tie-bow/tie-bow.yaml
  34. +0 −1 {modules/client/clothing-accessories → projects/clothing}/tie/tie.yaml
  35. +6 −2 {modules/client/clothing-costume-props/steampunk → projects/costume-props}/README.md
  36. +0 −1 ...ostume-props/steampunk → projects/costume-props}/assassins-creed-knife/assassins-creed-knife.yaml
  37. +0 −1 ...ostume-props/steampunk → projects/costume-props}/backpack-anti-vampire/backpack-anti-vampire.yaml
  38. +0 −1 ...es/client/clothing-costume-props → projects/costume-props}/backpack-jetpack/backpack-jetpack.yaml
  39. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/belt-utility/belt-utility.yaml
  40. +0 −1 ...lient/clothing-costume-props/steampunk → projects/costume-props}/blaster-steam/blaster-steam.yaml
  41. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/blaster/blaster.yaml
  42. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/cart/cart.yaml
  43. +0 −1 ...-costume-props/steampunk → projects/costume-props}/chimney-steam-tophat/chimney-steam-tophat.yaml
  44. +0 −1 ...lient/clothing-costume-props/steampunk → projects/costume-props}/chimney-steam/chimney-steam.yaml
  45. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/crown-tiara/crown-tiara.yaml
  46. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/crown/crown.yaml
  47. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/effect-fog/effect-fog.yaml
  48. +0 −1 ...ent/clothing-costume-props → projects/costume-props}/effect-odor-blaster/effect-odor-blaster.yaml
  49. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/effect-sneeze/effect-sneeze.yaml
  50. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/effect-sound/effect-sound.yaml
  51. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/effect-sparks/effect-sparks.yaml
  52. +1 −0 projects/costume-props/fire/fire.yaml
  53. +0 −1 ...ng-costume-props/steampunk → projects/costume-props}/goggles-telescoping/goggles-telescoping.yaml
  54. +0 −1 {modules/client/clothing-costume-props/steampunk → projects/costume-props}/goggles/goggles.yaml
  55. +1 −0 projects/costume-props/lightsaber/lightsaber.yaml
  56. +0 −1 {modules/client/clothing-costume-props/steampunk → projects/costume-props}/mech-arm/mech-arm.yaml
  57. +0 −1 ...ng-costume-props/steampunk → projects/costume-props}/mech-coupled-wheels/mech-coupled-wheels.yaml
  58. +0 −1 ...ules/client/clothing-costume-props/steampunk → projects/costume-props}/mech-gears/mech-gears.yaml
  59. +1 −0 projects/costume-props/proton-pack/proton-pack.yaml
  60. +0 −1 {modules/client/clothing-costume → projects/costume-props}/shoe-boot-mech/shoe-boot-mech.yaml
  61. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/sword/sword.yaml
  62. +5 −0 projects/costume-props/tricorder/tricorder.yaml
  63. +0 −1 {modules/client/clothing-costume-props → projects/costume-props}/visor/visor.yaml
  64. +0 −1 {modules/client/clothing-costume-props/steampunk → projects/costume-props}/whistle/whistle.yaml
  65. +4 −0 projects/costume-props/zf1/zf1.yaml
  66. +14 −4 {modules/client/clothing-costume → projects/costumes}/README.md
  67. +5 −0 projects/costumes/baymax/baymax.yaml
  68. +3 −0 projects/costumes/c-3po/c-3po.yaml
  69. +3 −0 projects/costumes/iron-giant/iron-giant.yaml
  70. +9 −0 projects/decor/README.md
  71. +3 −0 projects/decor/blinds-roller-motorized/blinds-roller-motorized.yml
  72. +8 −0 projects/decor/collectibles/README.md
  73. +5 −0 projects/decor/collectibles/millenium-falcon/millenium-falcon.yaml
  74. +4 −0 projects/decor/collectibles/serenity/serenity.yaml
  75. +7 −0 projects/decor/collectibles/tardis/tardis.yaml
  76. +3 −0 projects/decor/collectibles/tie-fighter/tie-fighter.yaml
  77. +4 −0 projects/decor/collectibles/x-wing/x-wing.yaml
  78. +7 −0 projects/furniture/README.md
  79. +2 −0 projects/gaming/README.md
  80. 0 projects/{game-motion-sim/game-motion-sim.yaml → gaming/motion-sim/motion-sim.yaml}
  81. +6 −0 projects/gaming/video-cabinet/video-cabinet.yaml
  82. +11 −0 projects/gaming/video-console/README.md
  83. +7 −0 projects/hair-accessories/README.md
  84. +0 −1 {modules/client/clothing-accessories → projects/hair-accessories}/hair-tie/hair-tie.yaml
  85. +0 −1 {modules/client/clothing-accessories → projects/hair-accessories}/headband/headband.yaml
  86. +3 −0 projects/hair-accessories/pigtails-fiber-optic/pigtails-fiber-optic.yaml
  87. +0 −1 ...ail-fiber-optic.yaml → projects/hair-accessories/pony-tail-fiber-optic/pony-tail-fiber-optic.yaml
  88. +7 −0 projects/health/README.md
  89. +8 −0 projects/health/mobility/README.md
  90. +4 −4 projects/music/README.md
  91. +7 −0 projects/novelty/README.md
  92. +1 −0 projects/novelty/knight-rider-light-bar/knight-rider-light-bar.yaml
  93. +3 −4 projects/puppets/README.md
  94. +4 −0 projects/puppets/b-e-n/b-e-n.yaml
  95. +4 −0 projects/puppets/bird/bird.yaml
  96. +4 −0 projects/puppets/burn-e/burn-e.yaml
  97. +6 −0 projects/puppets/dalek/dalek.yaml
  98. +8 −0 projects/puppets/eve/eve.yaml
  99. +4 −0 projects/puppets/johnny-5/johnny-5.yaml
  100. +5 −0 projects/puppets/k2so/k2so.yaml
  101. +3 −0 projects/puppets/k9/k9.yaml
  102. +3 −0 projects/puppets/m-o/m-o.yaml
  103. +4 −0 projects/puppets/marvin/marvin.yaml
  104. +3 −0 projects/puppets/omnidroid/omnidroid.yaml
  105. +4 −0 projects/puppets/r2-d2/r2-d2.yaml
  106. +8 −0 projects/puppets/tars/tars.yaml
  107. +3 −0 projects/puppets/ultron/ultron.yaml
  108. +5 −0 projects/puppets/wall-e/wall-e.yaml
  109. +2 −2 projects/robots/README.md
  110. +9 −0 projects/robots/cat/ear-cat/ear-cat.yaml
  111. +0 −1 {modules/client/robotics → projects/robots/cat}/eye-cat/eye-cat.yaml
  112. +0 −1 {modules/client/robotics → projects/robots/cat}/leg-cat/leg-cat.yaml
  113. +0 −1 {modules/client/robotics → projects/robots/dog}/ear-dog-floppy/ear-dog-floppy.yaml
  114. +9 −0 projects/robots/dog/ear-dog/ear-dog.yaml
  115. +0 −1 {modules/client/robotics → projects/robots/dog}/leg-dog/leg-dog.yaml
  116. +0 −1 {modules/client/robotics → projects/robots/humanoid}/ear/ear.yaml
  117. +0 −1 {modules/client/robotics → projects/robots/humanoid}/eye/eye.yaml
  118. +0 −1 {modules/client/robotics → projects/robots/humanoid}/eyelid/eyelid.yaml
  119. 0 {modules/client/robotics → projects/robots/humanoid}/hand/hand.yaml
  120. +0 −1 {modules/client/robotics → projects/robots/rabbit}/ear-rabbit/ear-rabbit.yaml
  121. +5 −0 projects/robots/spider/spider.yaml
  122. +3 −0 projects/robots/telepresence/telepresence.yaml
  123. +0 −1 {modules/client/robotics → projects/watercraft/eel}/vertebra-thoracic-eel/vertebra-thoracic-eel.yaml
  124. +0 −1 {modules/client/robotics → projects/watercraft/fish}/fin/fin.yaml
  125. +5 −0 projects/watercraft/fish/fish.yaml
  126. +7 −0 projects/watercraft/rov/README.md
  127. +0 −1 {modules/client/robotics → projects/watercraft/salamander}/leg-salamander/leg-salamander.yaml
  128. +4 −0 projects/watercraft/salamander/salamander.yaml
  129. +0 −1 ...tics → projects/watercraft/salamander}/vertebra-caudal-salamander/vertebra-caudal-salamander.yaml
  130. +0 −1 ... → projects/watercraft/salamander}/vertebra-thoracic-salamander/vertebra-thoracic-salamander.yaml
  131. +0 −1 ...rojects/watercraft/water-snake}/vertebra-thoracic-snake-sidewinder/vertebra-snake-sidewinder.yaml
  132. +3 −0 projects/workshop/README.md
View
@@ -13,7 +13,15 @@ Think the spec needs some revision? Please submit a pull request. Your feedback
Upcycling
---------
> "Upcycling is the process of converting old or discarded materials into
something useful and often beautiful."
-hipcycle.com
The Retro Modules framework provides many great opportunities to transform
junk-bin hardware (and/or their housings) into new inventions or variations
on the original product. Re-use these objects. Save them from the garbage
heap if possible. If the internals are no longer useful, send them to e-waste
facilities & re-use the enclosure.
Minimum Viable Products
-----------------------
@@ -44,9 +44,9 @@ legacy_colors:
5: yellow
6: blue
contacts:
1: i2c-clock
1: controller-area-network-low
2: pixel-data
3: twenty-volts-max
4: common
5: 1-wire
6: i2c-data
6: controller-area-network-high
View
@@ -1,7 +1,7 @@
---
name: DMX
summary: >
A standard for digital communication networks commonly used to control stage
lighting and effects.
reference:
- https://en.wikipedia.org/wiki/DMX512
- http://www.qlcplus.org
View
@@ -0,0 +1,11 @@
name: 1-wire
summary:
1-Wire is a device communications bus system that provides low-speed
data, signaling, and power over a single conductor.
aliases:
- one wire
- micro-lan
reference:
- https://en.wikipedia.org/wiki/1-Wire
related:
- inter-integrated-circuit
View
@@ -0,0 +1,13 @@
Modules
=======
A module is a device featuring connector(s) conforming to a certain spec.
By extension, a Retro Module is the same, featuring connector(s) conforming
to this spec.
Host
----
The device most central to a given modular system.
Client
------
A device which complements the host device in a given modular system.
View
@@ -21,12 +21,6 @@ triggering the brakes on hundreds of railroad cars), while others do not.
Classifying them all as client devices is a matter of convenience for those who
adopt this spec.
What is a Module?
-----------------
A module is a device featuring connector(s) conforming to a certain spec.
By extension, a Retro Module is the same, featuring connector(s) conforming
to this spec.
Maker Blueprint
===============
A set of helpful tools to speed along learning & development processes.

This file was deleted.

Oops, something went wrong.

This file was deleted.

Oops, something went wrong.
@@ -17,7 +17,7 @@ their character.
Modules listed here are meant to be generic in nature. You may be making
Falkor the luck dragon. You won't find a `falcor` module listed here, but there
is a [ear-dog-floppy](ear-dog-floppy/ear-dog-floppy.yaml) module. Use it as a
is a [ear-dog-floppy](../../../projects/robots/dog/ear-dog-floppy/ear-dog-floppy.yaml) module. Use it as a
starting point.
Module details are sparse, right now. More soon...

This file was deleted.

Oops, something went wrong.
View
@@ -20,12 +20,6 @@ re-program your car). Picturing microcontrollers as host devices is a matter
of convenience for those who write software for them.
For a microcontroller, all the world is an interface.
What is a Module?
-----------------
A module is a device featuring connector(s) conforming to a certain spec.
By extension, a Retro Module is the same, featuring connector(s) conforming
to this spec.
Resources
---------
Each include file contains a `getPin` function which returns an (integer)
View
@@ -1,2 +1,6 @@
Projects
========
A project may require many Retro Modules. It may require only one.
These are simply some ideas & references to existing projects which may
benefit from modular design patterns.
@@ -1,4 +1,3 @@
---
name: Backpack
summary: That thing you wore in school.
description: >
@@ -1,4 +1,3 @@
---
name: Badge
summary: Often used to display a company name and/or the name of the wearer.
reference:
@@ -1,3 +1,2 @@
---
name: Glow Belt
summary: Add popular luminous effects to a belt.
@@ -1,4 +1,3 @@
---
name: Belt
summary: Enhance belts by adding input interfaces & luminous effects.
ideas:
@@ -1,4 +1,3 @@
---
name: Clutch
summary: Carry only the essentials -- and some glowy stuff.
description: >
@@ -1,4 +1,3 @@
---
name: Necklace
summary: Add popular luminous effects to a necklace.
reference:
@@ -1,4 +1,3 @@
---
name: Purse
summary: Or satchel... if you'd like.
description: >
@@ -13,3 +13,20 @@ is more expensive & complex.
Just keep in mind: there is a balance which can be struck between gently
accentuated everyday clothes vs. all-out costumes.
Clothing Accessory Modules
--------------------------
Clothing accessories have gotten smart. From smart shirts to smart glasses to
smart shoes, computers today can be integrated into nearly anything.
This section is rated G & covers just a bit of what's out there.
Consider, as you build, adding wireless capabilities to your wearables. Most go
straight to Bluetooth control capabilities (which is cool)... but consider open
wireless protocols as well. A host module could broadcast, openly, control
signals to any other modules that might be listening. Your smart wardrobe (and
your friends' smart wardrobe) could always be in sync.
Make sure to comply with established local wireless regulations.
Reference
---------
https://en.wikipedia.org/wiki/Wearable_computer
@@ -1,4 +1,3 @@
---
name: Dress
summary: Add luminous, amorphous & other sophisticated effects to a dress.
description: >
@@ -1,4 +1,3 @@
---
name: Hoodie
summary: Add popular luminous effects to a hoodie.
reference:
@@ -1,4 +1,3 @@
---
name: Jacket
summary: Add popular luminous effects to a jacket.
description: >
@@ -1,4 +1,3 @@
---
name: Leg Warmers
summary: Add popular luminous effects to a pair of leg warmers.
description: >
@@ -1,8 +1,7 @@
---
name: Pants
summary: Add popular luminous effects to pants.
reference:
- https://blog.adafruit.com/2016/04/27/motion-activated-neopixel-pants-with-magnets-wearablewednesday/
- https://blog.adafruit.com/2016/04/27/motion-activated-neopixel-pants-with-magnets-wearablewednesday
connectors:
- jst-sm-4
- jst-sm-6
@@ -1,4 +1,3 @@
---
name: Shirt
summary: Add popular luminous effects to a shirt.
reference:
@@ -1,4 +1,3 @@
---
name: Boot
aliases:
- shoe
@@ -1,4 +1,3 @@
---
name: Heel
aliases:
- shoe
@@ -1,4 +1,3 @@
---
name: Sandal
aliases:
- shoe
@@ -1,4 +1,3 @@
---
name: Shoe
summary: Add popular luminous effects to shoes.
reference:
@@ -1,4 +1,3 @@
---
name: Shorts
see:
- pants
@@ -1,4 +1,3 @@
---
name: Dress
summary: Add popular luminous effects to a skirt.
description: >
@@ -1,4 +1,3 @@
---
name: Bowtie
summary: Glowy. Spinny. Polka-dotty.
description: >
@@ -1,4 +1,3 @@
---
name: Tie
summary: Add popular luminous effects to a tie.
reference:
@@ -1,5 +1,9 @@
Steampunk Modules
=================
Prop Modules
============
Modules designed to enhance a costume and/or set.
Steampunk Props
---------------
Brass. Leather. Soot. Steam... of course.
Steampunk is a subgenre of science fiction or science fantasy that incorporates technology and aesthetic designs inspired by 19th-century industrial steam-powered machinery. Although its literary origins are sometimes associated with the cyberpunk genre, steampunk works are often set in an alternative history of the 19th century's British Victorian era or American "Wild West", in a post-apocalyptic future during which steam power has maintained mainstream usage, or in a fantasy world that similarly employs steam power. Steampunk may, therefore, be described as neo-Victorian. Steampunk perhaps most recognisably features anachronistic technologies or retro-futuristic inventions as people in the 19th century might have envisioned them, and is likewise rooted in the era's perspective on fashion, culture, architectural style, and art.
@@ -1,4 +1,3 @@
---
name: Assassin's Creed Knife
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Anti-Vampire Backpack
categories:
- steampunk
@@ -1,3 +1,2 @@
---
name: Backpack Jetpack
summary: A backpack that looks like a jet pack.
@@ -1,3 +1,2 @@
---
name: Utility Belt
summary: Make a belt look like (and/or function as) a utility belt.
@@ -1,4 +1,3 @@
---
name: Blaster - Steam
categories:
- steampunk
@@ -1,3 +1,2 @@
---
name: Blaster
summary: Make a futuristic blaster replete with luminous & audible effects.
@@ -1,4 +1,3 @@
---
name: Cart
summary: A haul-along cart for personal accessories and/or additional effects.
ideas:
@@ -1,4 +1,3 @@
---
name: Tophat Chimney - Steam
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Chimney - Steam
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Tiara
summary: Add popular luminous effects to a tiara.
aliases:
@@ -1,3 +1,2 @@
---
name: Crown
summary: Add popular luminous and/or animatronic effects to a crown.
@@ -1,4 +1,3 @@
---
name: Fog
summary: Add fog effects to your costume.
notes:
@@ -1,4 +1,3 @@
---
name: Odor Blaster
summary: Add odorous effects to your costume.
notes:
@@ -1,4 +1,3 @@
---
name: Sneeze
summary: Add a sneeze effect to your costume.
notes:
@@ -1,4 +1,3 @@
---
name: Sound
summary: Add sound effects to your costume.
categories:
@@ -1,4 +1,3 @@
---
name: Sparks
summary: Add sparks effects to your costume.
notes:
@@ -0,0 +1 @@
name: Fire Prop
@@ -1,4 +1,3 @@
---
name: Telescoping Goggles
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Goggles
categories:
- steampunk
@@ -0,0 +1 @@
name: Lightsaber Prop
@@ -1,4 +1,3 @@
---
name: Mech Arm
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Mech Coupled Wheels
categories:
- steampunk
@@ -1,4 +1,3 @@
---
name: Mech Gears
categories:
- steampunk
@@ -0,0 +1 @@
name: Proton Pack Prop
@@ -1,4 +1,3 @@
---
name: Mech Boot
summary: Make robot boots all the more convincing with integrated effects.
description: >
@@ -1,4 +1,3 @@
---
name: Sword
summary: Add luminous & audible affects to a sword.
notes:
Oops, something went wrong.

0 comments on commit 1b526b1

Please sign in to comment.